/usr/share/doc/libjuce/apiref/classScopedWriteLock.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 | <!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: ScopedWriteLock 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> |
<a href="classScopedWriteLock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ScopedWriteLock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Automatically locks and unlocks a <a class="el" href="classReadWriteLock.html" title="A critical section that allows multiple simultaneous readers. ">ReadWriteLock</a> object.
<a href="classScopedWriteLock.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:ab06884cb60e1e7231cc0b16ed10d7004"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedWriteLock.html#ab06884cb60e1e7231cc0b16ed10d7004">ScopedWriteLock</a> (const <a class="el" href="classReadWriteLock.html">ReadWriteLock</a> &lock) noexcept</td></tr>
<tr class="memdesc:ab06884cb60e1e7231cc0b16ed10d7004"><td class="mdescLeft"> </td><td class="mdescRight">Creates a <a class="el" href="classScopedWriteLock.html" title="Automatically locks and unlocks a ReadWriteLock object. ">ScopedWriteLock</a>. <a href="#ab06884cb60e1e7231cc0b16ed10d7004">More...</a><br /></td></tr>
<tr class="separator:ab06884cb60e1e7231cc0b16ed10d7004"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a108b0a03c0b13ab6378b4ea68618d497"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classScopedWriteLock.html#a108b0a03c0b13ab6378b4ea68618d497">~ScopedWriteLock</a> () noexcept</td></tr>
<tr class="memdesc:a108b0a03c0b13ab6378b4ea68618d497"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a108b0a03c0b13ab6378b4ea68618d497">More...</a><br /></td></tr>
<tr class="separator:a108b0a03c0b13ab6378b4ea68618d497"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Automatically locks and unlocks a <a class="el" href="classReadWriteLock.html" title="A critical section that allows multiple simultaneous readers. ">ReadWriteLock</a> object. </p>
<p>Use one of these as a local variable to control access to a <a class="el" href="classReadWriteLock.html" title="A critical section that allows multiple simultaneous readers. ">ReadWriteLock</a>.</p>
<p>e.g.</p><div class="fragment"><div class="line"><a class="code" href="classReadWriteLock.html">ReadWriteLock</a> myLock;</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="classScopedWriteLock.html">ScopedWriteLock</a> myScopedLock (myLock);</div><div class="line"> <span class="comment">// myLock 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">// myLock gets unlocked here.</span></div><div class="line">}</div></div><!-- fragment --><dl class="section see"><dt>See also</dt><dd><a class="el" href="classReadWriteLock.html" title="A critical section that allows multiple simultaneous readers. ">ReadWriteLock</a>, <a class="el" href="classScopedReadLock.html" title="Automatically locks and unlocks a ReadWriteLock object. ">ScopedReadLock</a> </dd></dl>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a id="ab06884cb60e1e7231cc0b16ed10d7004"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab06884cb60e1e7231cc0b16ed10d7004">§ </a></span>ScopedWriteLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ScopedWriteLock::ScopedWriteLock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classReadWriteLock.html">ReadWriteLock</a> & </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="classScopedWriteLock.html" title="Automatically locks and unlocks a ReadWriteLock object. ">ScopedWriteLock</a>. </p>
<p>As soon as it is created, this will call <a class="el" href="classReadWriteLock.html#a680913272878d262ab8dff16b3b5a4e7" title="Locks this object for writing. ">ReadWriteLock::enterWrite()</a>, and when the <a class="el" href="classScopedWriteLock.html" title="Automatically locks and unlocks a ReadWriteLock object. ">ScopedWriteLock</a> object is deleted, the <a class="el" href="classReadWriteLock.html" title="A critical section that allows multiple simultaneous readers. ">ReadWriteLock</a> will be unlocked.</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="a108b0a03c0b13ab6378b4ea68618d497"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a108b0a03c0b13ab6378b4ea68618d497">§ </a></span>~ScopedWriteLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">ScopedWriteLock::~ScopedWriteLock </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 <a class="el" href="classReadWriteLock.html" title="A critical section that allows multiple simultaneous readers. ">ReadWriteLock</a>'s exitWrite() method will be called 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>
<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__ScopedWriteLock_8h.html">juce_ScopedWriteLock.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|