/usr/share/doc/libjuce/apiref/classSpinLock.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 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 | <!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: SpinLock 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-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classSpinLock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">SpinLock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations.
<a href="classSpinLock.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a8239db74a56ce60a114cd369ed6a41f0"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classGenericScopedLock.html">GenericScopedLock</a>< <a class="el" href="classSpinLock.html">SpinLock</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpinLock.html#a8239db74a56ce60a114cd369ed6a41f0">ScopedLockType</a></td></tr>
<tr class="memdesc:a8239db74a56ce60a114cd369ed6a41f0"><td class="mdescLeft"> </td><td class="mdescRight">Provides the type of scoped lock to use for locking a <a class="el" href="classSpinLock.html" title="A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations...">SpinLock</a>. <a href="#a8239db74a56ce60a114cd369ed6a41f0">More...</a><br /></td></tr>
<tr class="separator:a8239db74a56ce60a114cd369ed6a41f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae531d71996d5122e0caa8a10212cf585"><td class="memItemLeft" align="right" valign="top">typedef <a class="el" href="classGenericScopedUnlock.html">GenericScopedUnlock</a>< <a class="el" href="classSpinLock.html">SpinLock</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpinLock.html#ae531d71996d5122e0caa8a10212cf585">ScopedUnlockType</a></td></tr>
<tr class="memdesc:ae531d71996d5122e0caa8a10212cf585"><td class="mdescLeft"> </td><td class="mdescRight">Provides the type of scoped unlocker to use with a <a class="el" href="classSpinLock.html" title="A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations...">SpinLock</a>. <a href="#ae531d71996d5122e0caa8a10212cf585">More...</a><br /></td></tr>
<tr class="separator:ae531d71996d5122e0caa8a10212cf585"><td class="memSeparator" colspan="2"> </td></tr>
</table><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:a204af2b708c1678699ce0a235c229c64"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpinLock.html#a204af2b708c1678699ce0a235c229c64">SpinLock</a> () noexcept</td></tr>
<tr class="separator:a204af2b708c1678699ce0a235c229c64"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae5ac2bc2ea9faeb66d861ea0b9cdc7cd"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpinLock.html#ae5ac2bc2ea9faeb66d861ea0b9cdc7cd">~SpinLock</a> () noexcept</td></tr>
<tr class="separator:ae5ac2bc2ea9faeb66d861ea0b9cdc7cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a9079933ef4fdd1527fd0bf90f1062e02"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpinLock.html#a9079933ef4fdd1527fd0bf90f1062e02">enter</a> () const noexcept</td></tr>
<tr class="memdesc:a9079933ef4fdd1527fd0bf90f1062e02"><td class="mdescLeft"> </td><td class="mdescRight">Acquires the lock. <a href="#a9079933ef4fdd1527fd0bf90f1062e02">More...</a><br /></td></tr>
<tr class="separator:a9079933ef4fdd1527fd0bf90f1062e02"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4581a24b50dad1a9803b19f65af70aaf"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpinLock.html#a4581a24b50dad1a9803b19f65af70aaf">tryEnter</a> () const noexcept</td></tr>
<tr class="memdesc:a4581a24b50dad1a9803b19f65af70aaf"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to acquire the lock, returning true if this was successful. <a href="#a4581a24b50dad1a9803b19f65af70aaf">More...</a><br /></td></tr>
<tr class="separator:a4581a24b50dad1a9803b19f65af70aaf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a13a3a2f0d2a659b493a9c6e93e8d95f8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classSpinLock.html#a13a3a2f0d2a659b493a9c6e93e8d95f8">exit</a> () const noexcept</td></tr>
<tr class="memdesc:a13a3a2f0d2a659b493a9c6e93e8d95f8"><td class="mdescLeft"> </td><td class="mdescRight">Releases the lock. <a href="#a13a3a2f0d2a659b493a9c6e93e8d95f8">More...</a><br /></td></tr>
<tr class="separator:a13a3a2f0d2a659b493a9c6e93e8d95f8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations. </p>
<p>Note that unlike a <a class="el" href="classCriticalSection.html" title="A re-entrant mutex. ">CriticalSection</a>, this type of lock is not re-entrant, and may be less efficient when used it a highly contended situation, but it's very small and requires almost no initialisation. It's most appropriate for simple situations where you're only going to hold the lock for a very brief time.</p>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="classCriticalSection.html" title="A re-entrant mutex. ">CriticalSection</a> </dd></dl>
</div><h2 class="groupheader">Member Typedef Documentation</h2>
<a id="a8239db74a56ce60a114cd369ed6a41f0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8239db74a56ce60a114cd369ed6a41f0">§ </a></span>ScopedLockType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classGenericScopedLock.html">GenericScopedLock</a><<a class="el" href="classSpinLock.html">SpinLock</a>> <a class="el" href="classSpinLock.html#a8239db74a56ce60a114cd369ed6a41f0">SpinLock::ScopedLockType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the type of scoped lock to use for locking a <a class="el" href="classSpinLock.html" title="A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations...">SpinLock</a>. </p>
</div>
</div>
<a id="ae531d71996d5122e0caa8a10212cf585"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae531d71996d5122e0caa8a10212cf585">§ </a></span>ScopedUnlockType</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef <a class="el" href="classGenericScopedUnlock.html">GenericScopedUnlock</a><<a class="el" href="classSpinLock.html">SpinLock</a>> <a class="el" href="classSpinLock.html#ae531d71996d5122e0caa8a10212cf585">SpinLock::ScopedUnlockType</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Provides the type of scoped unlocker to use with a <a class="el" href="classSpinLock.html" title="A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations...">SpinLock</a>. </p>
</div>
</div>
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a204af2b708c1678699ce0a235c229c64"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a204af2b708c1678699ce0a235c229c64">§ </a></span>SpinLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SpinLock::SpinLock </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">
</div>
</div>
<a id="ae5ac2bc2ea9faeb66d861ea0b9cdc7cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5ac2bc2ea9faeb66d861ea0b9cdc7cd">§ </a></span>~SpinLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">SpinLock::~SpinLock </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">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a9079933ef4fdd1527fd0bf90f1062e02"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9079933ef4fdd1527fd0bf90f1062e02">§ </a></span>enter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SpinLock::enter </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>Acquires the lock. </p>
<p>This will block until the lock has been successfully acquired by this thread. Note that a <a class="el" href="classSpinLock.html" title="A simple spin-lock class that can be used as a simple, low-overhead mutex for uncontended situations...">SpinLock</a> is NOT re-entrant, and is not smart enough to know whether the caller thread already has the lock - so if a thread tries to acquire a lock that it already holds, this method will never return!</p>
<p>It's strongly recommended that you never call this method directly - instead use the ScopedLockType class to manage the locking using an RAII pattern instead. </p>
</div>
</div>
<a id="a4581a24b50dad1a9803b19f65af70aaf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4581a24b50dad1a9803b19f65af70aaf">§ </a></span>tryEnter()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool SpinLock::tryEnter </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>Attempts to acquire the lock, returning true if this was successful. </p>
</div>
</div>
<a id="a13a3a2f0d2a659b493a9c6e93e8d95f8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a13a3a2f0d2a659b493a9c6e93e8d95f8">§ </a></span>exit()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void SpinLock::exit </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>Releases the lock. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a1f96ab6751237979b907a54f52a7296a">jassert</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__SpinLock_8h.html">juce_SpinLock.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|