<!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>RAUL: Raul::Semaphore 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.7.1 -->
<div class="navigation" id="top">
<div class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div class="tabs2">
<ul class="tablist">
<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="navpath">
<ul>
<li><b>Raul</b> </li>
<li><a class="el" href="classRaul_1_1Semaphore.html">Raul::Semaphore</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> </div>
<div class="headertitle">
<h1>Raul::Semaphore Class Reference</h1> </div>
</div>
<div class="contents">
<!-- doxytag: class="Raul::Semaphore" -->
<p>Trivial wrapper around POSIX semaphores (zero memory overhead).
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="Semaphore_8hpp_source.html">Semaphore.hpp</a>></code></p>
<p><a href="classRaul_1_1Semaphore-members.html">List of all members.</a></p>
<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"><a class="anchor" id="a88064f667b635c1b57f4343572638c5c"></a><!-- doxytag: member="Raul::Semaphore::Semaphore" ref="a88064f667b635c1b57f4343572638c5c" args="(unsigned int initial)" -->
</td><td class="memItemRight" valign="bottom"><b>Semaphore</b> (unsigned int initial)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11e1cd531e918c7d06ed34616e83d023"></a><!-- doxytag: member="Raul::Semaphore::reset" ref="a11e1cd531e918c7d06ed34616e83d023" args="(unsigned int initial)" -->
void </td><td class="memItemRight" valign="bottom"><b>reset</b> (unsigned int initial)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac38aa50a95e47249aff5cfe631c58fe0"></a><!-- doxytag: member="Raul::Semaphore::has_waiter" ref="ac38aa50a95e47249aff5cfe631c58fe0" args="()" -->
bool </td><td class="memItemRight" valign="bottom"><b>has_waiter</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Semaphore.html#a5ae17e57432268156acaa23561eafe27">post</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increment (and signal any waiters). <a href="#a5ae17e57432268156acaa23561eafe27"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Semaphore.html#a0d17dc95c051e542791c226b648ce8bf">wait</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait until count is > 0, then decrement. <a href="#a0d17dc95c051e542791c226b648ce8bf"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classRaul_1_1Semaphore.html#adfb3336d3c186fe10dbefb07c12af2fd">try_wait</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Non-blocking version of <a class="el" href="classRaul_1_1Semaphore.html#a0d17dc95c051e542791c226b648ce8bf" title="Wait until count is > 0, then decrement.">wait()</a>. <a href="#adfb3336d3c186fe10dbefb07c12af2fd"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Trivial wrapper around POSIX semaphores (zero memory overhead). </p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a5ae17e57432268156acaa23561eafe27"></a><!-- doxytag: member="Raul::Semaphore::post" ref="a5ae17e57432268156acaa23561eafe27" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Raul::Semaphore::post </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Increment (and signal any waiters). </p>
<p>Realtime safe. </p>
<p>Referenced by <a class="el" href="classRaul_1_1Slave.html#a72d3a921abae1efaaede6d5f5bd4f8ac">Raul::Slave::whip()</a>.</p>
</div>
</div>
<a class="anchor" id="a0d17dc95c051e542791c226b648ce8bf"></a><!-- doxytag: member="Raul::Semaphore::wait" ref="a0d17dc95c051e542791c226b648ce8bf" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void Raul::Semaphore::wait </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Wait until count is > 0, then decrement. </p>
<p>Note that sem_wait always returns 0 in practice. It returns nonzero when run in GDB, so the while is necessary to allow debugging.</p>
<p>Obviously not realtime safe. </p>
<p>Referenced by <a class="el" href="classRaul_1_1Command.html#a3f2daf2be3086e05376440398c2533e0">Raul::Command::operator()()</a>.</p>
</div>
</div>
<a class="anchor" id="adfb3336d3c186fe10dbefb07c12af2fd"></a><!-- doxytag: member="Raul::Semaphore::try_wait" ref="adfb3336d3c186fe10dbefb07c12af2fd" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Raul::Semaphore::try_wait </td>
<td>(</td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Non-blocking version of <a class="el" href="classRaul_1_1Semaphore.html#a0d17dc95c051e542791c226b648ce8bf" title="Wait until count is > 0, then decrement.">wait()</a>. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if decrement was successful (lock was acquired).</dd></dl>
<p>Realtime safe? </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="Semaphore_8hpp_source.html">Semaphore.hpp</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Oct 6 2010 for RAUL by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.1 </small></address>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
88959ca903fe50462ea99715ead18944
>
files
>
163
