/usr/share/doc/libjuce/apiref/classGenericScopedLock.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 | <!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: GenericScopedLock< 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="classGenericScopedLock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">GenericScopedLock< LockType > Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Automatically locks and unlocks a mutex object.
<a href="classGenericScopedLock.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:acb13a2d16339b721c40951ce85005eeb"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGenericScopedLock.html#acb13a2d16339b721c40951ce85005eeb">GenericScopedLock</a> (const LockType &lock) noexcept</td></tr>
<tr class="memdesc:acb13a2d16339b721c40951ce85005eeb"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classGenericScopedLock.html" title="Automatically locks and unlocks a mutex object. ">GenericScopedLock</a>. <a href="#acb13a2d16339b721c40951ce85005eeb">More...</a><br /></td></tr>
<tr class="separator:acb13a2d16339b721c40951ce85005eeb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a02234589cd2f1c0ff057d4d64beb12e1"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGenericScopedLock.html#a02234589cd2f1c0ff057d4d64beb12e1">~GenericScopedLock</a> () noexcept</td></tr>
<tr class="memdesc:a02234589cd2f1c0ff057d4d64beb12e1"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a02234589cd2f1c0ff057d4d64beb12e1">More...</a><br /></td></tr>
<tr class="separator:a02234589cd2f1c0ff057d4d64beb12e1"><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 GenericScopedLock< 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="classGenericScopedLock.html">GenericScopedLock<CriticalSection></a> myScopedLock (myCriticalSection);</div><div class="line"> <span class="comment">// myCriticalSection is now locked</span></div><div class="line"></div><div class="line"> ...do some stuff...</div><div class="line"></div><div class="line"> <span class="comment">// myCriticalSection gets unlocked here.</span></div><div class="line">}</div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="classGenericScopedUnlock.html" title="Automatically unlocks and re-locks a mutex object. ">GenericScopedUnlock</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>, <a class="el" href="juce__CriticalSection_8h.html#acedaa6fb1373c96d2d15e7a617a5cec8" title="Automatically locks and unlocks a CriticalSection object. ">ScopedLock</a>, <a class="el" href="juce__CriticalSection_8h.html#a4cc435f24ace2a8f59b488ed66d9cf2c" title="Automatically unlocks and re-locks a CriticalSection object. ">ScopedUnlock</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="acb13a2d16339b721c40951ce85005eeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acb13a2d16339b721c40951ce85005eeb">§ </a></span>GenericScopedLock()</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="classGenericScopedLock.html">GenericScopedLock</a>< LockType >::<a class="el" href="classGenericScopedLock.html">GenericScopedLock</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="classGenericScopedLock.html" title="Automatically locks and unlocks a mutex object. ">GenericScopedLock</a>. </p>
<p>As soon as it is created, this will acquire the lock, and when the <a class="el" href="classGenericScopedLock.html" title="Automatically locks and unlocks a mutex object. ">GenericScopedLock</a> object is deleted, the lock will be released.</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="a02234589cd2f1c0ff057d4d64beb12e1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a02234589cd2f1c0ff057d4d64beb12e1">§ </a></span>~GenericScopedLock()</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="classGenericScopedLock.html">GenericScopedLock</a>< LockType >::~<a class="el" href="classGenericScopedLock.html">GenericScopedLock</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 lock will be released when the destructor is called. Make sure this object is created and deleted by the same thread, otherwise there are no guarantees what will happen! </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>
|