1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
|
<HTML>
<HEAD>
<TITLE>The Synthesis ToolKit in C++ (STK)</TITLE>
<LINK HREF="doxygen.css" REL="stylesheet" TYPE="text/css">
</HEAD>
<BODY BGCOLOR="#FFFFFF">
<CENTER>
<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.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" -->
<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">
<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></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>
<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-2012. </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>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<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>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<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>
<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-2012 Perry R. Cook and Gary P. Scavone. All Rights Reserved.</td></tr>
</table>
</BODY>
</HTML>
|
