libjuce-doc 4.3.0~repack-1 / usr / share / doc / libjuce / apiref / classWaitableEvent.html

This file is indexed.

/usr/share/doc/libjuce/apiref/classWaitableEvent.html is in libjuce-doc 4.3.0~repack-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
<!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.12"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>JUCE: WaitableEvent 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.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 id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">JUCE
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.12 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classWaitableEvent-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">WaitableEvent Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Allows threads to wait for events triggered by other threads.  
 <a href="classWaitableEvent.html#details">More...</a></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:aa3622062e48a177ec721120443ea17d2"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWaitableEvent.html#aa3622062e48a177ec721120443ea17d2">WaitableEvent</a> (bool manualReset=false) noexcept</td></tr>
<tr class="memdesc:aa3622062e48a177ec721120443ea17d2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Creates a <a class="el" href="classWaitableEvent.html" title="Allows threads to wait for events triggered by other threads. ">WaitableEvent</a> object.  <a href="#aa3622062e48a177ec721120443ea17d2">More...</a><br /></td></tr>
<tr class="separator:aa3622062e48a177ec721120443ea17d2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af071eb054ec0ce9b69eb98bd9508c2cf"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWaitableEvent.html#af071eb054ec0ce9b69eb98bd9508c2cf">~WaitableEvent</a> () noexcept</td></tr>
<tr class="memdesc:af071eb054ec0ce9b69eb98bd9508c2cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor.  <a href="#af071eb054ec0ce9b69eb98bd9508c2cf">More...</a><br /></td></tr>
<tr class="separator:af071eb054ec0ce9b69eb98bd9508c2cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aade120bc7686f4fabfc740aff8f56dfa"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWaitableEvent.html#aade120bc7686f4fabfc740aff8f56dfa">wait</a> (int timeOutMilliseconds=-1) const noexcept</td></tr>
<tr class="memdesc:aade120bc7686f4fabfc740aff8f56dfa"><td class="mdescLeft">&#160;</td><td class="mdescRight">Suspends the calling thread until the event has been signalled.  <a href="#aade120bc7686f4fabfc740aff8f56dfa">More...</a><br /></td></tr>
<tr class="separator:aade120bc7686f4fabfc740aff8f56dfa"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9afdf2e8cb15c457a44e85af3bffbf72"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWaitableEvent.html#a9afdf2e8cb15c457a44e85af3bffbf72">signal</a> () const noexcept</td></tr>
<tr class="memdesc:a9afdf2e8cb15c457a44e85af3bffbf72"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wakes up any threads that are currently waiting on this object.  <a href="#a9afdf2e8cb15c457a44e85af3bffbf72">More...</a><br /></td></tr>
<tr class="separator:a9afdf2e8cb15c457a44e85af3bffbf72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa9b3db111ba17e13d5e74360367bcc9b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classWaitableEvent.html#aa9b3db111ba17e13d5e74360367bcc9b">reset</a> () const noexcept</td></tr>
<tr class="memdesc:aa9b3db111ba17e13d5e74360367bcc9b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Resets the event to an unsignalled state.  <a href="#aa9b3db111ba17e13d5e74360367bcc9b">More...</a><br /></td></tr>
<tr class="separator:aa9b3db111ba17e13d5e74360367bcc9b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Allows threads to wait for events triggered by other threads. </p>
<p>A thread can call <a class="el" href="classWaitableEvent.html#aade120bc7686f4fabfc740aff8f56dfa" title="Suspends the calling thread until the event has been signalled. ">wait()</a> on a WaitableObject, and this will suspend the calling thread until another thread wakes it up by calling the <a class="el" href="classWaitableEvent.html#a9afdf2e8cb15c457a44e85af3bffbf72" title="Wakes up any threads that are currently waiting on this object. ">signal()</a> method. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="aa3622062e48a177ec721120443ea17d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3622062e48a177ec721120443ea17d2">&sect;&nbsp;</a></span>WaitableEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">WaitableEvent::WaitableEvent </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>manualReset</em> = <code>false</code></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Creates a <a class="el" href="classWaitableEvent.html" title="Allows threads to wait for events triggered by other threads. ">WaitableEvent</a> object. </p>
<p>The object is initially in an unsignalled state.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">manualReset</td><td>If this is false, the event will be reset automatically when the <a class="el" href="classWaitableEvent.html#aade120bc7686f4fabfc740aff8f56dfa" title="Suspends the calling thread until the event has been signalled. ">wait()</a> method is called. If manualReset is true, then once the event is signalled, the only way to reset it will be by calling the <a class="el" href="classWaitableEvent.html#aa9b3db111ba17e13d5e74360367bcc9b" title="Resets the event to an unsignalled state. ">reset()</a> method. </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="af071eb054ec0ce9b69eb98bd9508c2cf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af071eb054ec0ce9b69eb98bd9508c2cf">&sect;&nbsp;</a></span>~WaitableEvent()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">WaitableEvent::~WaitableEvent </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Destructor. </p>
<p>If other threads are waiting on this object when it gets deleted, this can cause nasty errors, so be careful! </p>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="aade120bc7686f4fabfc740aff8f56dfa"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aade120bc7686f4fabfc740aff8f56dfa">&sect;&nbsp;</a></span>wait()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool WaitableEvent::wait </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>timeOutMilliseconds</em> = <code>-1</code></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Suspends the calling thread until the event has been signalled. </p>
<p>This will wait until the object's <a class="el" href="classWaitableEvent.html#a9afdf2e8cb15c457a44e85af3bffbf72" title="Wakes up any threads that are currently waiting on this object. ">signal()</a> method is called by another thread, or until the timeout expires.</p>
<p>After the event has been signalled, this method will return true and if manualReset was set to false in the <a class="el" href="classWaitableEvent.html" title="Allows threads to wait for events triggered by other threads. ">WaitableEvent</a>'s constructor, then the event will be reset.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">timeOutMilliseconds</td><td>the maximum time to wait, in milliseconds. A negative value will cause it to wait forever.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the object has been signalled, false if the timeout expires first. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classWaitableEvent.html#a9afdf2e8cb15c457a44e85af3bffbf72" title="Wakes up any threads that are currently waiting on this object. ">signal</a>, <a class="el" href="classWaitableEvent.html#aa9b3db111ba17e13d5e74360367bcc9b" title="Resets the event to an unsignalled state. ">reset</a> </dd></dl>

</div>
</div>
<a id="a9afdf2e8cb15c457a44e85af3bffbf72"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9afdf2e8cb15c457a44e85af3bffbf72">&sect;&nbsp;</a></span>signal()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void WaitableEvent::signal </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Wakes up any threads that are currently waiting on this object. </p>
<p>If <a class="el" href="classWaitableEvent.html#a9afdf2e8cb15c457a44e85af3bffbf72" title="Wakes up any threads that are currently waiting on this object. ">signal()</a> is called when nothing is waiting, the next thread to call <a class="el" href="classWaitableEvent.html#aade120bc7686f4fabfc740aff8f56dfa" title="Suspends the calling thread until the event has been signalled. ">wait()</a> will return immediately and reset the signal.</p>
<p>If the <a class="el" href="classWaitableEvent.html" title="Allows threads to wait for events triggered by other threads. ">WaitableEvent</a> is manual reset, all current and future threads that wait upon this object will be woken, until <a class="el" href="classWaitableEvent.html#aa9b3db111ba17e13d5e74360367bcc9b" title="Resets the event to an unsignalled state. ">reset()</a> is explicitly called.</p>
<p>If the <a class="el" href="classWaitableEvent.html" title="Allows threads to wait for events triggered by other threads. ">WaitableEvent</a> is automatic reset, and one or more threads is waiting upon the object, then one of them will be woken up. If no threads are currently waiting, then the next thread to call <a class="el" href="classWaitableEvent.html#aade120bc7686f4fabfc740aff8f56dfa" title="Suspends the calling thread until the event has been signalled. ">wait()</a> will be woken up. As soon as a thread is woken, the signal is automatically reset.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classWaitableEvent.html#aade120bc7686f4fabfc740aff8f56dfa" title="Suspends the calling thread until the event has been signalled. ">wait</a>, <a class="el" href="classWaitableEvent.html#aa9b3db111ba17e13d5e74360367bcc9b" title="Resets the event to an unsignalled state. ">reset</a> </dd></dl>

</div>
</div>
<a id="aa9b3db111ba17e13d5e74360367bcc9b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa9b3db111ba17e13d5e74360367bcc9b">&sect;&nbsp;</a></span>reset()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void WaitableEvent::reset </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Resets the event to an unsignalled state. </p>
<p>If it's not already signalled, this does nothing. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__WaitableEvent_8h.html">juce_WaitableEvent.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content &copy ROLI Ltd.</small></address><br/>
</body>
</html>

APT Browse - Built by Thomas Orozco.