<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>GNU CommonC++: ost::Runable Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.6 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_runable.html">Runable</a></div>
<h1>ost::Runable Class Reference</h1><!-- doxytag: class="ost::Runable" -->A container for objects that can be queued against a runlist.runable object with notify when ready.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="misc_8h-source.html">misc.h</a>></code>
<p>
<a href="classost_1_1_runable-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#abc473eb135997a8708522e17433211f">starting</a> (<a class="el" href="classost_1_1_runlist.html">Runlist</a> *list)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Start the object against a run list. <a href="#abc473eb135997a8708522e17433211f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#cddf293eb7de735bf1f9c9015fdd80c5">stoping</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stop the object, called when stopping or ready completes. <a href="#cddf293eb7de735bf1f9c9015fdd80c5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#c0621e778853b90f2675eee8c0b0f71f">Runable</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#4b7babd1ac94658807797b2bbd4c261d">~Runable</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#a688f43efcca4a41a5f61eced310f27b">ready</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Method handler that is invoked when a wait-listed object becomes ready to run. <a href="#a688f43efcca4a41a5f61eced310f27b"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">class __EXPORT </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#1a29d36422d89e8af835a47abaa7d672">Runlist</a></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A container for objects that can be queued against a runlist.runable object with notify when ready.
<p>
<dl compact><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> </dd></dl>
<p>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="c0621e778853b90f2675eee8c0b0f71f"></a><!-- doxytag: member="ost::Runable::Runable" ref="c0621e778853b90f2675eee8c0b0f71f" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">ost::Runable::Runable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<a class="anchor" name="4b7babd1ac94658807797b2bbd4c261d"></a><!-- doxytag: member="ost::Runable::~Runable" ref="4b7babd1ac94658807797b2bbd4c261d" args="()" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual ost::Runable::~Runable </td>
<td class="md" valign="top">( </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a688f43efcca4a41a5f61eced310f27b"></a><!-- doxytag: member="ost::Runable::ready" ref="a688f43efcca4a41a5f61eced310f27b" args="(void)=0" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">virtual void ost::Runable::ready </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap><code> [protected, pure virtual]</code></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Method handler that is invoked when a wait-listed object becomes ready to run.
<p>
</td>
</tr>
</table>
<a class="anchor" name="abc473eb135997a8708522e17433211f"></a><!-- doxytag: member="ost::Runable::starting" ref="abc473eb135997a8708522e17433211f" args="(Runlist *list)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">bool ost::Runable::starting </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top"><a class="el" href="classost_1_1_runlist.html">Runlist</a> * </td>
<td class="mdname1" valign="top" nowrap> <em>list</em> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Start the object against a run list.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>true if immediately available to run. </dd></dl>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>list</em> </td><td>to start under. </td></tr>
</table>
</dl>
</td>
</tr>
</table>
<a class="anchor" name="cddf293eb7de735bf1f9c9015fdd80c5"></a><!-- doxytag: member="ost::Runable::stoping" ref="cddf293eb7de735bf1f9c9015fdd80c5" args="(void)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">void ost::Runable::stoping </td>
<td class="md" valign="top">( </td>
<td class="md" nowrap valign="top">void </td>
<td class="mdname1" valign="top" nowrap> </td>
<td class="md" valign="top"> ) </td>
<td class="md" nowrap></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
Stop the object, called when stopping or ready completes.
<p>
May also be used for a task that has not yet started to remove it from the wait list. </td>
</tr>
</table>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="1a29d36422d89e8af835a47abaa7d672"></a><!-- doxytag: member="ost::Runable::Runlist" ref="1a29d36422d89e8af835a47abaa7d672" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">friend class __EXPORT <a class="el" href="classost_1_1_runlist.html">Runlist</a><code> [friend]</code> </td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
</td>
<td>
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="misc_8h-source.html">misc.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jun 19 10:50:56 2006 for GNU CommonC++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.6 </small></address>
</body>
</html>
