mirror of
https://github.com/thestk/stk
synced 2026-04-20 06:26:55 +00:00
Release 4.4.2 tarball
This commit is contained in:
Gary Scavone
committed by
Stephen Sinclair
Stephen Sinclair
parent
c37de52787
commit
7fcf920d3e
@@ -8,66 +8,60 @@
|
||||
<img src="princeton.gif"> <img src="ccrma.gif"> <img src="mcgill.gif"><P>
|
||||
<a class="qindex" href="index.html">Home</a> <a class="qindex" href="information.html">Information</a> <a class="qindex" href="classes.html">Classes</a> <a class="qindex" href="download.html">Download</a> <a class="qindex" href="usage.html">Usage</a> <a class="qindex" href="maillist.html">Mail List</a> <a class="qindex" href="system.html">Requirements</a> <a class="qindex" href="links.html">Links</a> <a class="qindex" href="faq.html">FAQ</a> <a class="qindex" href="tutorial.html">Tutorial</a></CENTER>
|
||||
<HR>
|
||||
<!-- Generated by Doxygen 1.5.8 -->
|
||||
<!-- Generated by Doxygen 1.6.2 -->
|
||||
<div class="navpath"><a class="el" href="namespacestk.html">stk</a>::<a class="el" href="classstk_1_1Mutex.html">Mutex</a>
|
||||
</div>
|
||||
<div class="contents">
|
||||
<h1>stk::Mutex Class Reference</h1><!-- doxytag: class="stk::Mutex" --><!-- doxytag: inherits="stk::Stk" -->STK mutex class.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<code>#include <<a class="el" href="Mutex_8h-source.html">Mutex.h</a>></code>
|
||||
<p>
|
||||
<h1>stk::Mutex Class Reference</h1><!-- doxytag: class="stk::Mutex" --><!-- doxytag: inherits="stk::Stk" -->
|
||||
<p>STK mutex class.
|
||||
<a href="#_details">More...</a></p>
|
||||
|
||||
<p><code>#include <<a class="el" href="Mutex_8h_source.html">Mutex.h</a>></code></p>
|
||||
<div class="dynheader">
|
||||
Inheritance diagram for stk::Mutex:</div>
|
||||
<div class="dynsection">
|
||||
|
||||
<p><center><img src="classstk_1_1Mutex.png" usemap="#stk::Mutex_map" border="0" alt=""></center>
|
||||
<map name="stk::Mutex_map">
|
||||
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,67,24">
|
||||
<div class="center">
|
||||
<img src="classstk_1_1Mutex.png" usemap="#stk::Mutex_map" alt=""/>
|
||||
<map id="stk::Mutex_map" name="stk::Mutex_map">
|
||||
<area href="classstk_1_1Stk.html" alt="stk::Stk" shape="rect" coords="0,0,67,24"/>
|
||||
</map>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<p>
|
||||
<a href="classstk_1_1Mutex-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"><a class="anchor" name="869b23f40be55c01cc381290de1d1375"></a><!-- doxytag: member="stk::Mutex::Mutex" ref="869b23f40be55c01cc381290de1d1375" args="()" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#869b23f40be55c01cc381290de1d1375">Mutex</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="63df62eabfb7976e34951145d7a7ced3"></a><!-- doxytag: member="stk::Mutex::~Mutex" ref="63df62eabfb7976e34951145d7a7ced3" args="()" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#63df62eabfb7976e34951145d7a7ced3">~Mutex</a> ()</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f2bb62c13745502b58644189d1db5b35"></a><!-- doxytag: member="stk::Mutex::lock" ref="f2bb62c13745502b58644189d1db5b35" args="(void)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#f2bb62c13745502b58644189d1db5b35">lock</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lock the mutex. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e518f6d3177dd8c2138eccb8944591ee"></a><!-- doxytag: member="stk::Mutex::unlock" ref="e518f6d3177dd8c2138eccb8944591ee" args="(void)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#e518f6d3177dd8c2138eccb8944591ee">unlock</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unlock the mutex. <br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#fa637fae8940d6c3ad42384439962bbe">wait</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait indefinitely on the mutex condition variable. <a href="#fa637fae8940d6c3ad42384439962bbe"></a><br></td></tr>
|
||||
<tr><td class="memItemLeft" nowrap align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#c3e3e69efa1587cb1f65fb645a8d43db">signal</a> (void)</td></tr>
|
||||
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal the condition variable. <a href="#c3e3e69efa1587cb1f65fb645a8d43db"></a><br></td></tr>
|
||||
<p><a href="classstk_1_1Mutex-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"><a class="anchor" id="a869b23f40be55c01cc381290de1d1375"></a><!-- doxytag: member="stk::Mutex::Mutex" ref="a869b23f40be55c01cc381290de1d1375" args="()" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#a869b23f40be55c01cc381290de1d1375">Mutex</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a63df62eabfb7976e34951145d7a7ced3"></a><!-- doxytag: member="stk::Mutex::~Mutex" ref="a63df62eabfb7976e34951145d7a7ced3" args="()" -->
|
||||
</td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#a63df62eabfb7976e34951145d7a7ced3">~Mutex</a> ()</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Class destructor. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2bb62c13745502b58644189d1db5b35"></a><!-- doxytag: member="stk::Mutex::lock" ref="af2bb62c13745502b58644189d1db5b35" args="(void)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#af2bb62c13745502b58644189d1db5b35">lock</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Lock the mutex. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae518f6d3177dd8c2138eccb8944591ee"></a><!-- doxytag: member="stk::Mutex::unlock" ref="ae518f6d3177dd8c2138eccb8944591ee" args="(void)" -->
|
||||
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#ae518f6d3177dd8c2138eccb8944591ee">unlock</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Unlock the mutex. <br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#afa637fae8940d6c3ad42384439962bbe">wait</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Wait indefinitely on the mutex condition variable. <a href="#afa637fae8940d6c3ad42384439962bbe"></a><br/></td></tr>
|
||||
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classstk_1_1Mutex.html#ac3e3e69efa1587cb1f65fb645a8d43db">signal</a> (void)</td></tr>
|
||||
<tr><td class="mdescLeft"> </td><td class="mdescRight">Signal the condition variable. <a href="#ac3e3e69efa1587cb1f65fb645a8d43db"></a><br/></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
STK mutex class.
|
||||
<p>
|
||||
This class provides a uniform interface for cross-platform mutex use. On Linux and IRIX systems, the pthread library is used. Under Windows, critical sections are used.<p>
|
||||
by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" name="fa637fae8940d6c3ad42384439962bbe"></a><!-- doxytag: member="stk::Mutex::wait" ref="fa637fae8940d6c3ad42384439962bbe" args="(void)" -->
|
||||
<hr/><a name="_details"></a><h2>Detailed Description</h2>
|
||||
<p>STK mutex class. </p>
|
||||
<p>This class provides a uniform interface for cross-platform mutex use. On Linux and IRIX systems, the pthread library is used. Under Windows, critical sections are used.</p>
|
||||
<p>by Perry R. Cook and Gary P. Scavone, 1995 - 2010. </p>
|
||||
<hr/><h2>Member Function Documentation</h2>
|
||||
<a class="anchor" id="afa637fae8940d6c3ad42384439962bbe"></a><!-- doxytag: member="stk::Mutex::wait" ref="afa637fae8940d6c3ad42384439962bbe" args="(void)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void stk::Mutex::wait </td>
|
||||
<td class="memname">void stk::Mutex::wait </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"> </td>
|
||||
<td class="paramname"></td>
|
||||
<td> ) </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
@@ -75,21 +69,20 @@ by Perry R. Cook and Gary P. Scavone, 1995 - 2009. <hr><h2>Member Function Docum
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
Wait indefinitely on the mutex condition variable.
|
||||
<p>
|
||||
The mutex must be locked before calling this function, and then subsequently unlocked after this function returns.
|
||||
<p>Wait indefinitely on the mutex condition variable. </p>
|
||||
<p>The mutex must be locked before calling this function, and then subsequently unlocked after this function returns. </p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<a class="anchor" name="c3e3e69efa1587cb1f65fb645a8d43db"></a><!-- doxytag: member="stk::Mutex::signal" ref="c3e3e69efa1587cb1f65fb645a8d43db" args="(void)" -->
|
||||
</div>
|
||||
<a class="anchor" id="ac3e3e69efa1587cb1f65fb645a8d43db"></a><!-- doxytag: member="stk::Mutex::signal" ref="ac3e3e69efa1587cb1f65fb645a8d43db" args="(void)" -->
|
||||
<div class="memitem">
|
||||
<div class="memproto">
|
||||
<table class="memname">
|
||||
<tr>
|
||||
<td class="memname">void stk::Mutex::signal </td>
|
||||
<td class="memname">void stk::Mutex::signal </td>
|
||||
<td>(</td>
|
||||
<td class="paramtype">void </td>
|
||||
<td class="paramname"> </td>
|
||||
<td class="paramname"></td>
|
||||
<td> ) </td>
|
||||
<td></td>
|
||||
</tr>
|
||||
@@ -97,20 +90,20 @@ The mutex must be locked before calling this function, and then subsequently unl
|
||||
</div>
|
||||
<div class="memdoc">
|
||||
|
||||
<p>
|
||||
Signal the condition variable.
|
||||
<p>
|
||||
The mutex must be locked before calling this function, and then subsequently unlocked after this function returns.
|
||||
<p>Signal the condition variable. </p>
|
||||
<p>The mutex must be locked before calling this function, and then subsequently unlocked after this function returns. </p>
|
||||
|
||||
</div>
|
||||
</div><p>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="Mutex_8h-source.html">Mutex.h</a></ul>
|
||||
</div>
|
||||
<hr/>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="Mutex_8h_source.html">Mutex.h</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<HR>
|
||||
|
||||
<table>
|
||||
<tr><td><A HREF="http://ccrma.stanford.edu/software/stk/"><I>The Synthesis ToolKit in C++ (STK)</I></A></td></tr>
|
||||
<tr><td>©1995-2009 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
<tr><td>©1995-2010 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
|
||||
</table>
|
||||
|
||||
</BODY>
|
||||
|
||||
Reference in New Issue
Block a user