src/components/cms/api_docs/activemqcpp-3.4.0/html/classactivemq_1_1threads_1_1_task.html - activemq-website - Git at Google

 <!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>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <title>activemq-cpp-3.4.0: activemq::threads::Task Class Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <link href="navtree.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="navtree.js"></script>
 <script type="text/javascript" src="resize.js"></script>
 <script type="text/javascript">
 $(document).ready(initResizable);
 </script>
 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
 </head>
 <body>
 <!-- Generated by Doxygen 1.7.3 -->
 <div id="top">
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 56px;">
   <td style="padding-left: 0.5em;">
    <div id="projectname">activemq-cpp-3.4.0</div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
       <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
     </ul>
   </div>
   <div id="navrow2" class="tabs2">
     <ul class="tablist">
       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
       <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
     </ul>
   </div>
 </div>
 <div id="side-nav" class="ui-resizable side-nav-resizable">
   <div id="nav-tree">
     <div id="nav-tree-contents">
     </div>
   </div>
   <div id="splitbar" style="-moz-user-select:none;"
        class="ui-resizable-handle">
   </div>
 </div>
 <script type="text/javascript">
   initNavTree('classactivemq_1_1threads_1_1_task.html','');
 </script>
 <div id="doc-content">
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a>  </div>
   <div class="headertitle">
 <h1>activemq::threads::Task Class Reference</h1>  </div>
 </div>
 <div class="contents">
 <!-- doxytag: class="activemq::threads::Task" -->
 <p>Represents a unit of work that requires one or more iterations to complete.
 <a href="#_details">More...</a></p>

 <p><code>#include &lt;<a class="el" href="_task_8h_source.html">src/main/activemq/threads/Task.h</a>&gt;</code></p>
 <div class="dynheader">
 Inheritance diagram for activemq::threads::Task:</div>
 <div class="dyncontent">
 <div class="center"><img src="classactivemq_1_1threads_1_1_task__inherit__graph.png" border="0" usemap="#activemq_1_1threads_1_1_task_inherit__map" alt="Inheritance graph"/></div>
 <map name="activemq_1_1threads_1_1_task_inherit__map" id="activemq_1_1threads_1_1_task_inherit__map">
 <area shape="rect" id="node3" href="classactivemq_1_1core_1_1_active_m_q_session_executor.html" title="Delegate dispatcher for a single session." alt="" coords="240,5,555,35"/><area shape="rect" id="node5" href="classactivemq_1_1threads_1_1_composite_task.html" title="Represents a single task that can be part of a set of Tasks that are contained in a CompositeTaskRunn..." alt="" coords="268,59,527,88"/><area shape="rect" id="node13" href="classactivemq_1_1threads_1_1_composite_task_runner.html" title="A Task Runner that can contain one or more CompositeTasks that are each checked for pending work and ..." alt="" coords="244,112,551,141"/><area shape="rect" id="node7" href="classactivemq_1_1transport_1_1failover_1_1_backup_transport_pool.html" title="activemq::transport::failover::BackupTransportPool" alt="" coords="604,5,969,35"/><area shape="rect" id="node9" href="classactivemq_1_1transport_1_1failover_1_1_close_transports_task.html" title="activemq::transport::failover::CloseTransportsTask" alt="" coords="605,59,968,88"/><area shape="rect" id="node11" href="classactivemq_1_1transport_1_1failover_1_1_failover_transport.html" title="activemq::transport::failover::FailoverTransport" alt="" coords="616,112,957,141"/></map>
 <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
 <table class="memberdecls">
 <tr><td colspan="2"><h2><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1threads_1_1_task.html#a6fea152f5bd1447b19ab45b7c6d97d5d">~Task</a> ()</td></tr>
 <tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1threads_1_1_task.html#acd905a469028d795da2d4e4cb4c7447b">iterate</a> ()=0</td></tr>
 <tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform one iteration of work, returns true if the task needs to run again to complete or false to indicate that the task is now complete.  <a href="#acd905a469028d795da2d4e4cb4c7447b"></a><br/></td></tr>
 </table>
 <hr/><a name="_details"></a><h2>Detailed Description</h2>
 <div class="textblock"><p>Represents a unit of work that requires one or more iterations to complete. </p>
 <dl class="since"><dt><b>Since:</b></dt><dd>3.0 </dd></dl>
 </div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="a6fea152f5bd1447b19ab45b7c6d97d5d"></a><!-- doxytag: member="activemq::threads::Task::~Task" ref="a6fea152f5bd1447b19ab45b7c6d97d5d" args="()" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">virtual activemq::threads::Task::~Task </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td><code> [inline, virtual]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 </div>
 </div>
 <hr/><h2>Member Function Documentation</h2>
 <a class="anchor" id="acd905a469028d795da2d4e4cb4c7447b"></a><!-- doxytag: member="activemq::threads::Task::iterate" ref="acd905a469028d795da2d4e4cb4c7447b" args="()=0" -->
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">virtual bool activemq::threads::Task::iterate </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td><code> [pure virtual]</code></td>
         </tr>
       </table>
 </div>
 <div class="memdoc">

 <p>Perform one iteration of work, returns true if the task needs to run again to complete or false to indicate that the task is now complete. </p>
 <dl class="return"><dt><b>Returns:</b></dt><dd>true if the task should be run again or false if the task has completed and the runner should wait for a wakeup call. </dd></dl>

 <p>Implemented in <a class="el" href="classactivemq_1_1core_1_1_active_m_q_session_executor.html#acc72b296e5dc658860aff9734f5b79e5">activemq::core::ActiveMQSessionExecutor</a>, <a class="el" href="classactivemq_1_1threads_1_1_composite_task_runner.html#a54a8bad6fe7fcf08e386257282001d3a">activemq::threads::CompositeTaskRunner</a>, <a class="el" href="classactivemq_1_1transport_1_1failover_1_1_backup_transport_pool.html#a5404e1841221c18b1fae2ec640e0ad90">activemq::transport::failover::BackupTransportPool</a>, <a class="el" href="classactivemq_1_1transport_1_1failover_1_1_close_transports_task.html#a6d07b1b9e68728c54ebdd20d491bc549">activemq::transport::failover::CloseTransportsTask</a>, and <a class="el" href="classactivemq_1_1transport_1_1failover_1_1_failover_transport.html#a407c82cfefc517ad4665be7b22ffb943">activemq::transport::failover::FailoverTransport</a>.</p>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>src/main/activemq/threads/<a class="el" href="_task_8h_source.html">Task.h</a></li>
 </ul>
 </div>
 </div>
   <div id="nav-path" class="navpath">
     <ul>
       <li class="navelem"><a class="el" href="namespaceactivemq.html">activemq</a>      </li>
       <li class="navelem"><a class="el" href="namespaceactivemq_1_1threads.html">threads</a>      </li>
       <li class="navelem"><a class="el" href="classactivemq_1_1threads_1_1_task.html">Task</a>      </li>
       <li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by&#160;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
     </ul>
   </div>

 </body>
 </html>
	<!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>
	<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
	<title>activemq-cpp-3.4.0: activemq::threads::Task Class Reference</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<link href="navtree.css" rel="stylesheet" type="text/css"/>
	<script type="text/javascript" src="jquery.js"></script>
	<script type="text/javascript" src="navtree.js"></script>
	<script type="text/javascript" src="resize.js"></script>
	<script type="text/javascript">
	$(document).ready(initResizable);
	</script>
	<link href="doxygen.css" rel="stylesheet" type="text/css"/>
	</head>
	<body>
	<!-- Generated by Doxygen 1.7.3 -->
	<div id="top">
	<div id="titlearea">
	<table cellspacing="0" cellpadding="0">
	<tbody>
	<tr style="height: 56px;">
	<td style="padding-left: 0.5em;">
	<div id="projectname">activemq-cpp-3.4.0</div>
	</td>
	</tr>
	</tbody>
	</table>
	</div>
	<div id="navrow1" class="tabs">
	<ul class="tablist">
	<li><a href="index.html"><span>Main Page</span></a></li>
	<li><a href="namespaces.html"><span>Namespaces</span></a></li>
	<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
	<li><a href="files.html"><span>Files</span></a></li>
	</ul>
	</div>
	<div id="navrow2" class="tabs2">
	<ul class="tablist">
	<li><a href="annotated.html"><span>Data Structures</span></a></li>
	<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
	<li><a href="functions.html"><span>Data Fields</span></a></li>
	</ul>
	</div>
	</div>
	<div id="side-nav" class="ui-resizable side-nav-resizable">
	<div id="nav-tree">
	<div id="nav-tree-contents">
	</div>
	</div>
	<div id="splitbar" style="-moz-user-select:none;"
	class="ui-resizable-handle">
	</div>
	</div>
	<script type="text/javascript">
	initNavTree('classactivemq_1_1threads_1_1_task.html','');
	</script>
	<div id="doc-content">
	<div class="header">
	<div class="summary">
	<a href="#pub-methods">Public Member Functions</a> </div>
	<div class="headertitle">
	<h1>activemq::threads::Task Class Reference</h1> </div>
	</div>
	<div class="contents">
	<!-- doxytag: class="activemq::threads::Task" -->
	<p>Represents a unit of work that requires one or more iterations to complete.
	<a href="#_details">More...</a></p>

	<p><code>#include <<a class="el" href="_task_8h_source.html">src/main/activemq/threads/Task.h</a>></code></p>
	<div class="dynheader">
	Inheritance diagram for activemq::threads::Task:</div>
	<div class="dyncontent">
	<div class="center"><img src="classactivemq_1_1threads_1_1_task__inherit__graph.png" border="0" usemap="#activemq_1_1threads_1_1_task_inherit__map" alt="Inheritance graph"/></div>
	<map name="activemq_1_1threads_1_1_task_inherit__map" id="activemq_1_1threads_1_1_task_inherit__map">
	<area shape="rect" id="node3" href="classactivemq_1_1core_1_1_active_m_q_session_executor.html" title="Delegate dispatcher for a single session." alt="" coords="240,5,555,35"/><area shape="rect" id="node5" href="classactivemq_1_1threads_1_1_composite_task.html" title="Represents a single task that can be part of a set of Tasks that are contained in a CompositeTaskRunn..." alt="" coords="268,59,527,88"/><area shape="rect" id="node13" href="classactivemq_1_1threads_1_1_composite_task_runner.html" title="A Task Runner that can contain one or more CompositeTasks that are each checked for pending work and ..." alt="" coords="244,112,551,141"/><area shape="rect" id="node7" href="classactivemq_1_1transport_1_1failover_1_1_backup_transport_pool.html" title="activemq::transport::failover::BackupTransportPool" alt="" coords="604,5,969,35"/><area shape="rect" id="node9" href="classactivemq_1_1transport_1_1failover_1_1_close_transports_task.html" title="activemq::transport::failover::CloseTransportsTask" alt="" coords="605,59,968,88"/><area shape="rect" id="node11" href="classactivemq_1_1transport_1_1failover_1_1_failover_transport.html" title="activemq::transport::failover::FailoverTransport" alt="" coords="616,112,957,141"/></map>
	<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
	<table class="memberdecls">
	<tr><td colspan="2"><h2><a name="pub-methods"></a>
	Public Member Functions</h2></td></tr>
	<tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1threads_1_1_task.html#a6fea152f5bd1447b19ab45b7c6d97d5d">~Task</a> ()</td></tr>
	<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classactivemq_1_1threads_1_1_task.html#acd905a469028d795da2d4e4cb4c7447b">iterate</a> ()=0</td></tr>
	<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform one iteration of work, returns true if the task needs to run again to complete or false to indicate that the task is now complete. <a href="#acd905a469028d795da2d4e4cb4c7447b"></a><br/></td></tr>
	</table>
	<hr/><a name="_details"></a><h2>Detailed Description</h2>
	<div class="textblock"><p>Represents a unit of work that requires one or more iterations to complete. </p>
	<dl class="since"><dt><b>Since:</b></dt><dd>3.0 </dd></dl>
	</div><hr/><h2>Constructor & Destructor Documentation</h2>
	<a class="anchor" id="a6fea152f5bd1447b19ab45b7c6d97d5d"></a><!-- doxytag: member="activemq::threads::Task::~Task" ref="a6fea152f5bd1447b19ab45b7c6d97d5d" args="()" -->
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">virtual activemq::threads::Task::~Task </td>
	<td>(</td>
	<td class="paramname"></td><td>)</td>
	<td><code> [inline, virtual]</code></td>
	</tr>
	</table>
	</div>
	<div class="memdoc">

	</div>
	</div>
	<hr/><h2>Member Function Documentation</h2>
	<a class="anchor" id="acd905a469028d795da2d4e4cb4c7447b"></a><!-- doxytag: member="activemq::threads::Task::iterate" ref="acd905a469028d795da2d4e4cb4c7447b" args="()=0" -->
	<div class="memitem">
	<div class="memproto">
	<table class="memname">
	<tr>
	<td class="memname">virtual bool activemq::threads::Task::iterate </td>
	<td>(</td>
	<td class="paramname"></td><td>)</td>
	<td><code> [pure virtual]</code></td>
	</tr>
	</table>
	</div>
	<div class="memdoc">

	<p>Perform one iteration of work, returns true if the task needs to run again to complete or false to indicate that the task is now complete. </p>
	<dl class="return"><dt><b>Returns:</b></dt><dd>true if the task should be run again or false if the task has completed and the runner should wait for a wakeup call. </dd></dl>

	<p>Implemented in <a class="el" href="classactivemq_1_1core_1_1_active_m_q_session_executor.html#acc72b296e5dc658860aff9734f5b79e5">activemq::core::ActiveMQSessionExecutor</a>, <a class="el" href="classactivemq_1_1threads_1_1_composite_task_runner.html#a54a8bad6fe7fcf08e386257282001d3a">activemq::threads::CompositeTaskRunner</a>, <a class="el" href="classactivemq_1_1transport_1_1failover_1_1_backup_transport_pool.html#a5404e1841221c18b1fae2ec640e0ad90">activemq::transport::failover::BackupTransportPool</a>, <a class="el" href="classactivemq_1_1transport_1_1failover_1_1_close_transports_task.html#a6d07b1b9e68728c54ebdd20d491bc549">activemq::transport::failover::CloseTransportsTask</a>, and <a class="el" href="classactivemq_1_1transport_1_1failover_1_1_failover_transport.html#a407c82cfefc517ad4665be7b22ffb943">activemq::transport::failover::FailoverTransport</a>.</p>

	</div>
	</div>
	<hr/>The documentation for this class was generated from the following file:<ul>
	<li>src/main/activemq/threads/<a class="el" href="_task_8h_source.html">Task.h</a></li>
	</ul>
	</div>
	</div>
	<div id="nav-path" class="navpath">
	<ul>
	<li class="navelem"><a class="el" href="namespaceactivemq.html">activemq</a> </li>
	<li class="navelem"><a class="el" href="namespaceactivemq_1_1threads.html">threads</a> </li>
	<li class="navelem"><a class="el" href="classactivemq_1_1threads_1_1_task.html">Task</a> </li>
	<li class="footer">Generated on Mon Apr 25 2011 for activemq-cpp-3.4.0 by
	<a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </li>
	</ul>
	</div>

	</body>
	</html>