<!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>GNU CommonC++: ost::Runable Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="navigation" id="top"> <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 class="current"><a href="annotated.html"><span>Classes</span></a></li> <li><a href="files.html"><span>Files</span></a></li> <li><a href="examples.html"><span>Examples</span></a></li> </ul> </div> <div class="tabs"> <ul> <li><a href="annotated.html"><span>Class List</span></a></li> <li><a href="classes.html"><span>Class Index</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="navpath"><a class="el" href="namespaceost.html">ost</a>::<a class="el" href="classost_1_1_runable.html">Runable</a> </div> </div> <div class="contents"> <h1>ost::Runable Class Reference</h1><!-- doxytag: class="ost::Runable" --> <p>A container for objects that can be queued against a runlist. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="misc_8h_source.html">misc.h</a>></code></p> <p><a href="classost_1_1_runable-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#aabc473eb135997a8708522e17433211f">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="#aabc473eb135997a8708522e17433211f"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#acddf293eb7de735bf1f9c9015fdd80c5">stoping</a> (void)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Stop the object, called when stopping or ready completes. <a href="#acddf293eb7de735bf1f9c9015fdd80c5"></a><br/></td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#ac0621e778853b90f2675eee8c0b0f71f">Runable</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#a4b7babd1ac94658807797b2bbd4c261d">~Runable</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#aa688f43efcca4a41a5f61eced310f27b">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="#aa688f43efcca4a41a5f61eced310f27b"></a><br/></td></tr> <tr><td colspan="2"><h2>Friends</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="classost_1_1_runable.html#ac53e8802cca4f6d9df833c8f9b558344">Runlist</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>A container for objects that can be queued against a runlist. </p> <dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@ostel.com">dyfet@ostel.com</a>> runable object with notify when ready. </dd></dl> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="ac0621e778853b90f2675eee8c0b0f71f"></a><!-- doxytag: member="ost::Runable::Runable" ref="ac0621e778853b90f2675eee8c0b0f71f" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">ost::Runable::Runable </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a4b7babd1ac94658807797b2bbd4c261d"></a><!-- doxytag: member="ost::Runable::~Runable" ref="a4b7babd1ac94658807797b2bbd4c261d" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual ost::Runable::~Runable </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td><code> [protected, virtual]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="aa688f43efcca4a41a5f61eced310f27b"></a><!-- doxytag: member="ost::Runable::ready" ref="aa688f43efcca4a41a5f61eced310f27b" args="(void)=0" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">virtual void ost::Runable::ready </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td><code> [protected, pure virtual]</code></td> </tr> </table> </div> <div class="memdoc"> <p>Method handler that is invoked when a wait-listed object becomes ready to run. </p> </div> </div> <a class="anchor" id="aabc473eb135997a8708522e17433211f"></a><!-- doxytag: member="ost::Runable::starting" ref="aabc473eb135997a8708522e17433211f" args="(Runlist *list)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">bool ost::Runable::starting </td> <td>(</td> <td class="paramtype"><a class="el" href="classost_1_1_runlist.html">Runlist</a> * </td> <td class="paramname"> <em>list</em></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Start the object against a run list. </p> <dl class="return"><dt><b>Returns:</b></dt><dd>true if immediately available to run. </dd></dl> <dl><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> </dd> </dl> </div> </div> <a class="anchor" id="acddf293eb7de735bf1f9c9015fdd80c5"></a><!-- doxytag: member="ost::Runable::stoping" ref="acddf293eb7de735bf1f9c9015fdd80c5" args="(void)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void ost::Runable::stoping </td> <td>(</td> <td class="paramtype">void </td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>Stop the object, called when stopping or ready completes. </p> <p>May also be used for a task that has not yet started to remove it from the wait list. </p> </div> </div> <hr/><h2>Friends And Related Function Documentation</h2> <a class="anchor" id="ac53e8802cca4f6d9df833c8f9b558344"></a><!-- doxytag: member="ost::Runable::Runlist" ref="ac53e8802cca4f6d9df833c8f9b558344" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="classost_1_1_runlist.html">Runlist</a><code> [friend]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <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></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Fri Nov 12 09:55:47 2010 for GNU CommonC++ by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>