<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Class Poco::ActiveDispatcher</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
<meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/>
<meta name="language" content="en"/>
<meta name="date" content="2009-11-24"/>
<meta name="generator" content="PocoDoc"/>
<link rel="stylesheet" href="css/styles.css" type="text/css"/>
</head>
<body bgcolor="#ffffff" leftmargin="0" topmargin="0">
<div class="header">
<h1 class="namespace"><a href="Poco.html" class="namespace">Poco</a></h1>
<h1 class="symbol">class ActiveDispatcher</h1>
</div>
<div class="body">
<p>
<b>Library:</b> Foundation<br />
<b>Package:</b> Threading<br />
<b>Header:</b> Poco/ActiveDispatcher.h</p>
<h2>Description</h2>
<div class="description">
<p>This class is used to implement an active object with strictly serialized method execution. </p>
<p>An active object, with is an ordinary object containing <a href="Poco.ActiveMethod.html" title="class Poco::ActiveMethod">ActiveMethod</a> members, executes all active methods in their own thread. This behavior does not fit the "classic" definition of an active object, which serializes the execution of active methods (in other words, only one active method can be running at any given time). </p>
<p>Using this class as a base class, the serializing behavior for active objects can be implemented. </p>
<p>The following example shows how this is done: </p>
<p></p>
<pre>class ActiveObject: public ActiveDispatcher
{
public:
ActiveObject():
exampleActiveMethod(this, &ActiveObject::exampleActiveMethodImpl)
{
}
ActiveMethod<std::string, std::string, ActiveObject, ActiveStarter<ActiveDispatcher> > exampleActiveMethod;
protected:
std::string exampleActiveMethodImpl(const std::string& arg)
{
...
}
};
</pre>
<p>The only things different from the example in <a href="Poco.ActiveMethod.html" title="class Poco::ActiveMethod">ActiveMethod</a> is that the ActiveObject in this case inherits from <a href="Poco.ActiveDispatcher.html" title="class Poco::ActiveDispatcher">ActiveDispatcher</a>, and that the <a href="Poco.ActiveMethod.html" title="class Poco::ActiveMethod">ActiveMethod</a> template for exampleActiveMethod has an additional parameter, specifying the specialized <a href="Poco.ActiveStarter.html" title="class Poco::ActiveStarter">ActiveStarter</a> for <a href="Poco.ActiveDispatcher.html" title="class Poco::ActiveDispatcher">ActiveDispatcher</a>. </p>
</div>
<h2>Inheritance</h2>
<p><b>Direct Base Classes: </b><a href="Poco.Runnable.html" title="class Poco::Runnable">Runnable</a></p>
<p><b>All Base Classes: </b><a href="Poco.Runnable.html" title="class Poco::Runnable">Runnable</a></p>
<h2>Member Summary</h2>
<p><b>Member Functions: </b><a href="Poco.ActiveDispatcher.html#3395" title="Poco::ActiveDispatcher::cancel()">cancel</a>, <a href="Poco.ActiveDispatcher.html#3396" title="Poco::ActiveDispatcher::run()">run</a>, <a href="Poco.ActiveDispatcher.html#3393" title="Poco::ActiveDispatcher::start()">start</a>, <a href="Poco.ActiveDispatcher.html#3397" title="Poco::ActiveDispatcher::stop()">stop</a></p>
<p><b>Inherited Functions: </b><a href="Poco.Runnable.html#9810" title="Poco::Runnable::run()">run</a></p>
<h2>Constructors</h2>
<h3><a name="3389">ActiveDispatcher</a></h3>
<p class="decl"><a href="Poco.ActiveDispatcher.html" title="class Poco::ActiveDispatcher">ActiveDispatcher</a>();</p>
<div class="description">
<p>Creates the <a href="Poco.ActiveDispatcher.html" title="class Poco::ActiveDispatcher">ActiveDispatcher</a>. </p>
</div>
<h3><a name="3390">ActiveDispatcher</a></h3>
<p class="decl"><a href="Poco.ActiveDispatcher.html" title="class Poco::ActiveDispatcher">ActiveDispatcher</a>(<br /> <a href="Poco.Thread.html#10815" title="enum Poco::Thread::Priority">Thread::Priority</a> prio<br />);</p>
<div class="description">
<p>Creates the <a href="Poco.ActiveDispatcher.html" title="class Poco::ActiveDispatcher">ActiveDispatcher</a> and sets the priority of its thread. </p>
</div>
<h2>Destructor</h2>
<h3><a name="3392">~ActiveDispatcher</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">virtual ~<a href="Poco.ActiveDispatcher.html" title="class Poco::ActiveDispatcher">ActiveDispatcher</a>();</p>
<div class="description">
<p>Destroys the <a href="Poco.ActiveDispatcher.html" title="class Poco::ActiveDispatcher">ActiveDispatcher</a>. </p>
</div>
<h2>Member Functions</h2>
<h3><a name="3395">cancel</a></h3>
<p class="decl">void cancel();</p>
<div class="description">
<p>Cancels all queued methods. </p>
</div>
<h3><a name="3393">start</a></h3>
<p class="decl">void start(<br /> <a href="Poco.ActiveRunnableBase.html#3473" title="Poco::ActiveRunnableBase::Ptr">ActiveRunnableBase::Ptr</a> pRunnable<br />);</p>
<div class="description">
<p>Adds the <a href="Poco.Runnable.html" title="class Poco::Runnable">Runnable</a> to the dispatch queue. </p>
</div>
<h3><a name="3396">run</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void run();</p>
<div class="description">
<p></p>
</div>
<div class="description"><p><b>See also:</b> <a href="Poco.Runnable.html#9810" title="Poco::Runnable::run()">Poco::Runnable::run()</a></p></div>
<h3><a name="3397">stop</a> <img src="images/protected.gif" alt="protected" title="protected" style="vertical-align:baseline;" border="0" /> </h3>
<p class="decl">void stop();</p>
<div class="description">
<p></p>
</div>
<p class="footer">POCO C++ Libraries 1.3.6-all<br />
Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p>
</div>
</body>
</html>
