<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.5"/> <title>GNU CommonC++: ost::Runable Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">GNU CommonC++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.5 --> <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>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 id="navrow2" class="tabs2"> <ul class="tablist"> <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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceost.html">ost</a></li><li class="navelem"><a class="el" href="classost_1_1_runable.html">Runable</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#friends">Friends</a> | <a href="classost_1_1_runable-members.html">List of all members</a> </div> <div class="headertitle"> <div class="title">ost::Runable Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div> </div><!--header--> <div class="contents"> <p>A container for objects that can be queued against a runlist. <a href="classost_1_1_runable.html#details">More...</a></p> <p><code>#include <<a class="el" href="misc_8h_source.html">misc.h</a>></code></p> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:aabc473eb135997a8708522e17433211f"><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 class="memdesc:aabc473eb135997a8708522e17433211f"><td class="mdescLeft"> </td><td class="mdescRight">Start the object against a run list. <a href="#aabc473eb135997a8708522e17433211f">More...</a><br/></td></tr> <tr class="separator:aabc473eb135997a8708522e17433211f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acddf293eb7de735bf1f9c9015fdd80c5"><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 class="memdesc:acddf293eb7de735bf1f9c9015fdd80c5"><td class="mdescLeft"> </td><td class="mdescRight">Stop the object, called when stopping or ready completes. <a href="#acddf293eb7de735bf1f9c9015fdd80c5">More...</a><br/></td></tr> <tr class="separator:acddf293eb7de735bf1f9c9015fdd80c5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:ac0621e778853b90f2675eee8c0b0f71f"><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 class="separator:ac0621e778853b90f2675eee8c0b0f71f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a4b7babd1ac94658807797b2bbd4c261d"><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 class="separator:a4b7babd1ac94658807797b2bbd4c261d"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aa688f43efcca4a41a5f61eced310f27b"><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 class="memdesc:aa688f43efcca4a41a5f61eced310f27b"><td class="mdescLeft"> </td><td class="mdescRight">Method handler that is invoked when a wait-listed object becomes ready to run. <a href="#aa688f43efcca4a41a5f61eced310f27b">More...</a><br/></td></tr> <tr class="separator:aa688f43efcca4a41a5f61eced310f27b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:ac53e8802cca4f6d9df833c8f9b558344"><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> <tr class="separator:ac53e8802cca4f6d9df833c8f9b558344"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><p>A container for objects that can be queued against a runlist. </p> <dl class="section author"><dt>Author</dt><dd>David Sugar <a href="#" onclick="location.href='mai'+'lto:'+'dyf'+'et'+'@os'+'te'+'l.c'+'om'; return false;">dyfet<span style="display: none;">.nosp@m.</span>@ost<span style="display: none;">.nosp@m.</span>el.co<span style="display: none;">.nosp@m.</span>m</a> runable object with notify when ready. </dd></dl> </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> <a class="anchor" id="ac0621e778853b90f2675eee8c0b0f71f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">ost::Runable::Runable </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <a class="anchor" id="a4b7babd1ac94658807797b2bbd4c261d"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">virtual ost::Runable::~Runable </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">virtual</span></span> </td> </tr> </table> </div><div class="memdoc"> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a class="anchor" id="aa688f43efcca4a41a5f61eced310f27b"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <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></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">protected</span><span class="mlabel">pure virtual</span></span> </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> <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="section return"><dt>Returns</dt><dd>true if immediately available to run. </dd></dl> <dl class="params"><dt>Parameters</dt><dd> <table class="params"> <tr><td class="paramname">list</td><td>to start under. </td></tr> </table> </dd> </dl> </div> </div> <a class="anchor" id="acddf293eb7de735bf1f9c9015fdd80c5"></a> <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> <h2 class="groupheader">Friends And Related Function Documentation</h2> <a class="anchor" id="ac53e8802cca4f6d9df833c8f9b558344"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">friend class <a class="el" href="classost_1_1_runlist.html">Runlist</a></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">friend</span></span> </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><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Thu Oct 17 2013 23:24:57 for GNU CommonC++ by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.5 </small></address> </body> </html>