<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <title>Class Waitable - Class Waitable</title> <link href="faldoc.css" rel="stylesheet" type="text/css"/> <link href="tabs.css" rel="stylesheet" type="text/css"/> </head> <body class="faldoc_body"> <div class="navitop"> <div class="tabs"> <ul> <li><a href="./index.html"><span>Main</span></a></li> <li><a href="./modules.html"><span>Modules</span></a></li> <li><a href="./pages.html"><span>Related pages</span></a></li> <li><a href="./groups.html"><span>Groups</span></a></li> <li><a href="./classes.html"><span>Classes</span></a></li> <li><a href="./objects.html"><span>Objects</span></a></li> <li><a href="./functions.html"><span>All functions</span></a></li> <li><a href="./enum.html"><span>Enumerations</span></a></li> </ul> </div> </div> <hr/> <h1 class="faldoc_title">Class Waitable<span class="faldoc_belong"><a href="./module_feathers_threading.html">[in Threading]</a></p></h1> <p class="faldoc_brief">Base abstract class for synchronization Structures. </p> <p class="faldoc_funcdecl"> <b>class</b> Waitable </p> <p class="faldoc_brief"><a href="#more">more...</a></p> <h2 class="faldoc_title">Summary</h2> <table class="faldoc_list"> <tr><td><a href="#release">release()</a></td><td>Releases a structure acquired by a waiting function. </td></tr> </table> <a name="more"><h2 class="faldoc_title">Detailed description</h2></a> <p class="faldoc_funcdecl"> <b>class</b> Waitable </p> <table class="faldoc_function"> </table> <br/> <p class="item_brief">Base abstract class for synchronization Structures. </p> <p class="faldoc_text"> Actually, this class represents the interface exposed by synchronization structures to script. Objects derived from this class can be used in functions and methods in the group <a href="./group_waiting_funcs.html">Waitings</a>. Usually, the Waitable class is implemented by Structures, but any object providing a mean to be acquired, released and waited for a change in the acquirability state can be derived from this class. </p> <p class="faldoc_text"> Currently, only the <a href="./class_Waitable.html#release">Waitable.release</a> method is exposed to scripts; this means that scripts cannot create their own waitable objects, but only use those provided by this or other modules. </p> <h2 class="faldoc_title">Methods</h2> <h3 class="faldoc_funcname"><a name="release">release()</a></h3> <p class="item_brief">Releases a structure acquired by a waiting function. </p> <p class="faldoc_funcdecl">Waitable.release( )</p> <p class="faldoc_text"><p class="faldoc_text">Unless the nature of the acquired object is known, and that object is known not to require release, every acquired object must be explicitly released after a succesful wait. </p> </p> <hr/> <div class="navibottom"> <center> <a href="./index.html">Main</a> - <a href="./modules.html">Modules</a> - <a href="./pages.html">Related pages</a> - <a href="./groups.html">Groups</a> - <a href="./classes.html">Classes</a> - <a href="./objects.html">Objects</a> - <a href="./functions.html">All functions</a> - <a href="./enum.html">Enumerations</a> </center> </div> </div> <div class="faldoc_signature">Made with <a href="http://www.falconpl.org">faldoc 2.2.0</div> </body> </html>