/usr/share/doc/libjuce/apiref/classGenericScopedTryLock.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 | <!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: GenericScopedTryLock< LockType > Class Template 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> |
<a href="classGenericScopedTryLock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GenericScopedTryLock< LockType > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Automatically locks and unlocks a mutex object.
<a href="classGenericScopedTryLock.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:a2d8b85eb72c754b7d2162c3cc296f30a"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGenericScopedTryLock.html#a2d8b85eb72c754b7d2162c3cc296f30a">GenericScopedTryLock</a> (const LockType &lock) noexcept</td></tr>
<tr class="memdesc:a2d8b85eb72c754b7d2162c3cc296f30a"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classGenericScopedTryLock.html" title="Automatically locks and unlocks a mutex object. ">GenericScopedTryLock</a>. <a href="#a2d8b85eb72c754b7d2162c3cc296f30a">More...</a><br /></td></tr>
<tr class="separator:a2d8b85eb72c754b7d2162c3cc296f30a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa552ec1121d42230080f6dbc614ead99"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGenericScopedTryLock.html#aa552ec1121d42230080f6dbc614ead99">~GenericScopedTryLock</a> () noexcept</td></tr>
<tr class="memdesc:aa552ec1121d42230080f6dbc614ead99"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#aa552ec1121d42230080f6dbc614ead99">More...</a><br /></td></tr>
<tr class="separator:aa552ec1121d42230080f6dbc614ead99"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0504fe1e14b9a246e5e6018132578b94"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGenericScopedTryLock.html#a0504fe1e14b9a246e5e6018132578b94">isLocked</a> () const noexcept</td></tr>
<tr class="memdesc:a0504fe1e14b9a246e5e6018132578b94"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if the mutex was successfully locked. <a href="#a0504fe1e14b9a246e5e6018132578b94">More...</a><br /></td></tr>
<tr class="separator:a0504fe1e14b9a246e5e6018132578b94"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class LockType><br />
class GenericScopedTryLock< LockType ></h3>
<p>Automatically locks and unlocks a mutex object. </p>
<p>Use one of these as a local variable to provide RAII-based locking of a mutex.</p>
<p>The templated class could be a <a class="el" href="classCriticalSection.html" title="A re-entrant mutex. ">CriticalSection</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>, or anything else that provides enter() and exit() methods.</p>
<p>e.g.</p><div class="fragment"><div class="line"><a class="code" href="classCriticalSection.html">CriticalSection</a> myCriticalSection;</div><div class="line"></div><div class="line"><span class="keywordflow">for</span> (;;)</div><div class="line">{</div><div class="line"> <span class="keyword">const</span> <a class="code" href="classGenericScopedTryLock.html">GenericScopedTryLock<CriticalSection></a> myScopedTryLock (myCriticalSection);</div><div class="line"></div><div class="line"> <span class="comment">// Unlike using a ScopedLock, this may fail to actually get the lock, so you</span></div><div class="line"> <span class="comment">// should test this with the isLocked() method before doing your thread-unsafe</span></div><div class="line"> <span class="comment">// action..</span></div><div class="line"> <span class="keywordflow">if</span> (myScopedTryLock.isLocked())</div><div class="line"> {</div><div class="line"> ...do some stuff...</div><div class="line"> }</div><div class="line"> <span class="keywordflow">else</span></div><div class="line"> {</div><div class="line"> ..our attempt at locking failed because another thread had already locked it..</div><div class="line"> }</div><div class="line"></div><div class="line"> <span class="comment">// myCriticalSection gets unlocked here (if it was locked)</span></div><div class="line">}</div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="classCriticalSection.html#a2c12101da7ebf8455de49652f377d313" title="Attempts to lock this critical section without blocking. ">CriticalSection::tryEnter</a>, <a class="el" href="classGenericScopedLock.html" title="Automatically locks and unlocks a mutex object. ">GenericScopedLock</a>, <a class="el" href="classGenericScopedUnlock.html" title="Automatically unlocks and re-locks a mutex object. ">GenericScopedUnlock</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="a2d8b85eb72c754b7d2162c3cc296f30a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d8b85eb72c754b7d2162c3cc296f30a">§ </a></span>GenericScopedTryLock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class LockType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGenericScopedTryLock.html">GenericScopedTryLock</a>< LockType >::<a class="el" href="classGenericScopedTryLock.html">GenericScopedTryLock</a> </td>
<td>(</td>
<td class="paramtype">const LockType & </td>
<td class="paramname"><em>lock</em></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="classGenericScopedTryLock.html" title="Automatically locks and unlocks a mutex object. ">GenericScopedTryLock</a>. </p>
<p>As soon as it is created, this will attempt to acquire the lock, and when the <a class="el" href="classGenericScopedTryLock.html" title="Automatically locks and unlocks a mutex object. ">GenericScopedTryLock</a> is deleted, the lock will be released (if the lock was successfully acquired).</p>
<p>Make sure this object is created and deleted by the same thread, otherwise there are no guarantees what will happen! Best just to use it as a local stack object, rather than creating one with the new() operator. </p>
</div>
</div>
<a id="aa552ec1121d42230080f6dbc614ead99"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa552ec1121d42230080f6dbc614ead99">§ </a></span>~GenericScopedTryLock()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class LockType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGenericScopedTryLock.html">GenericScopedTryLock</a>< LockType >::~<a class="el" href="classGenericScopedTryLock.html">GenericScopedTryLock</a> </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>The mutex will be unlocked (if it had been successfully locked) when the destructor is called.</p>
<p>Make sure this object is created and deleted by the same thread, otherwise there are no guarantees what will happen! </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a0504fe1e14b9a246e5e6018132578b94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0504fe1e14b9a246e5e6018132578b94">§ </a></span>isLocked()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class LockType> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classGenericScopedTryLock.html">GenericScopedTryLock</a>< LockType >::isLocked </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>Returns true if the mutex was successfully locked. </p>
<p>References <a class="el" href="juce__PlatformDefs_8h.html#a6ab7a603bf4435c7cb286b1744366eb2">JUCE_DECLARE_NON_COPYABLE</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__ScopedLock_8h.html">juce_ScopedLock.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|