/usr/share/doc/libjuce/apiref/classInterProcessLock.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 | <!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: InterProcessLock 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="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classInterProcessLock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">InterProcessLock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Acts as a critical section which processes can use to block each other.
<a href="classInterProcessLock.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterProcessLock_1_1ScopedLockType.html">ScopedLockType</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Automatically locks and unlocks an <a class="el" href="classInterProcessLock.html" title="Acts as a critical section which processes can use to block each other. ">InterProcessLock</a> object. <a href="classInterProcessLock_1_1ScopedLockType.html#details">More...</a><br /></td></tr>
<tr class="separator:"><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:aa4bb20ad9b280ba608e570f8ece8351e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterProcessLock.html#aa4bb20ad9b280ba608e570f8ece8351e">InterProcessLock</a> (const <a class="el" href="classString.html">String</a> &name)</td></tr>
<tr class="memdesc:aa4bb20ad9b280ba608e570f8ece8351e"><td class="mdescLeft"> </td><td class="mdescRight">Creates a lock object. <a href="#aa4bb20ad9b280ba608e570f8ece8351e">More...</a><br /></td></tr>
<tr class="separator:aa4bb20ad9b280ba608e570f8ece8351e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a464f2a7c6a841b37534f1d1cbe5c1571"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterProcessLock.html#a464f2a7c6a841b37534f1d1cbe5c1571">~InterProcessLock</a> ()</td></tr>
<tr class="memdesc:a464f2a7c6a841b37534f1d1cbe5c1571"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <a href="#a464f2a7c6a841b37534f1d1cbe5c1571">More...</a><br /></td></tr>
<tr class="separator:a464f2a7c6a841b37534f1d1cbe5c1571"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00d7b9e49bf365eedc923f622e330179"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterProcessLock.html#a00d7b9e49bf365eedc923f622e330179">enter</a> (int timeOutMillisecs=-1)</td></tr>
<tr class="memdesc:a00d7b9e49bf365eedc923f622e330179"><td class="mdescLeft"> </td><td class="mdescRight">Attempts to lock the critical section. <a href="#a00d7b9e49bf365eedc923f622e330179">More...</a><br /></td></tr>
<tr class="separator:a00d7b9e49bf365eedc923f622e330179"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3387e77951f1777be407cf76d2691bd0"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classInterProcessLock.html#a3387e77951f1777be407cf76d2691bd0">exit</a> ()</td></tr>
<tr class="memdesc:a3387e77951f1777be407cf76d2691bd0"><td class="mdescLeft"> </td><td class="mdescRight">Releases the lock if it's currently held by this process. <a href="#a3387e77951f1777be407cf76d2691bd0">More...</a><br /></td></tr>
<tr class="separator:a3387e77951f1777be407cf76d2691bd0"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Acts as a critical section which processes can use to block each other. </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">Constructor & Destructor Documentation</h2>
<a id="aa4bb20ad9b280ba608e570f8ece8351e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa4bb20ad9b280ba608e570f8ece8351e">§ </a></span>InterProcessLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">InterProcessLock::InterProcessLock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classString.html">String</a> & </td>
<td class="paramname"><em>name</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">explicit</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Creates a lock object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">name</td><td>a name that processes will use to identify this lock object </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a464f2a7c6a841b37534f1d1cbe5c1571"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a464f2a7c6a841b37534f1d1cbe5c1571">§ </a></span>~InterProcessLock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">InterProcessLock::~InterProcessLock </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Destructor. </p>
<p>This will also release the lock if it's currently held by this process. </p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a00d7b9e49bf365eedc923f622e330179"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00d7b9e49bf365eedc923f622e330179">§ </a></span>enter()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool InterProcessLock::enter </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>timeOutMillisecs</em> = <code>-1</code></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Attempts to lock the critical section. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeOutMillisecs</td><td>how many milliseconds to wait if the lock is already held by another process - a value of 0 will return immediately, negative values will wait forever </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if the lock could be gained within the timeout period, or false if the timeout expired. </dd></dl>
<p>Referenced by <a class="el" href="classInterProcessLock_1_1ScopedLockType.html#a8ce60f7f55e0ca70f0e288e9000ed0c7">InterProcessLock::ScopedLockType::ScopedLockType()</a>.</p>
</div>
</div>
<a id="a3387e77951f1777be407cf76d2691bd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3387e77951f1777be407cf76d2691bd0">§ </a></span>exit()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void InterProcessLock::exit </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Releases the lock if it's currently held by this process. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="juce__InterProcessLock_8h.html">juce_InterProcessLock.h</a></li>
</ul>
</div><!-- contents -->
<hr class="footer"/>
<address class="footer"><small>All content © ROLI Ltd.</small></address><br/>
</body>
</html>
|