/usr/share/GNUstep/Documentation/Developer/Base/Reference/NSDistributedLock.html is in gnustep-base-doc 1.24.7-1build2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>NSDistributedLock class reference</title>
</head>
<body>
<font face="serif">
<a href="Base.html">Up</a>
<br />
<h1><a name="title$NSDistributedLock">NSDistributedLock class reference</a></h1>
<h3>Authors</h3>
<dl>
<dt>Richard Frith-Macdonald (<a href="mailto:richard@brainstorm.co.uk"><code>richard@brainstorm.co.uk</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Version:</b> 37003</p>
<p><b>Date:</b> 2013-08-22 16:44:54 +0100 (Thu, 22 Aug 2013)</p>
<p><b>Copyright:</b> (C) 1997 Free Software Foundation, Inc.</p>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the NSDistributedLock class
</a></h1>
<h2><a name="class$NSDistributedLock">NSDistributedLock</a> : <a rel="gsdoc" href="NSObject.html#class$NSObject">NSObject</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>Foundation/NSDistributedLock.h</dd>
</dl>
</blockquote>
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
This class does not adopt the
<a rel="gsdoc" href="NSLock.html#protocol$(NSLocking)"><NSLocking></a>
protocol but supports locking across processes,
including processes on different machines, as
<strong>long</strong> as they can access a common
filesystem.
</div>
<hr width="50%" align="left" />
<a href="#_NSDistributedLock_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="NSDistributedLock.html#method$NSDistributedLock+lockWithPath$">+lockWithPath:</a></li>
<li><a rel="gsdoc" href="NSDistributedLock.html#method$NSDistributedLock-breakLock">-breakLock</a></li>
<li><a rel="gsdoc" href="NSDistributedLock.html#method$NSDistributedLock-initWithPath$">-initWithPath:</a></li>
<li><a rel="gsdoc" href="NSDistributedLock.html#method$NSDistributedLock-lockDate">-lockDate</a></li>
<li><a rel="gsdoc" href="NSDistributedLock.html#method$NSDistributedLock-tryLock">-tryLock</a></li>
<li><a rel="gsdoc" href="NSDistributedLock.html#method$NSDistributedLock-unlock">-unlock</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$NSDistributedLock+lockWithPath$">lockWithPath: </a></h3>
+ (<a rel="gsdoc" href="#class$NSDistributedLock">NSDistributedLock</a>*) <b>lockWithPath:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aPath;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Return a distributed lock for <var>aPath</var>. See
<a rel="gsdoc" href="#method$NSDistributedLock-initWithPath$">
-initWithPath:
</a>
for details.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSDistributedLock-breakLock">breakLock </a></h3>
- (void) <b>breakLock</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Forces release of the lock whether the receiver owns
it or not. <br /> Raises an NSGenericException if unable
to remove the lock.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSDistributedLock-initWithPath$">initWithPath: </a></h3>
- (id) <b>initWithPath:</b> (<a rel="gsdoc" href="NSString.html#class$NSString">NSString</a>*)aPath;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Initialises the receiver with the specified
filesystem path. <br /> The location in the
filesystem must be accessible for this to be
usable. That is, the processes using the lock must
be able to access, create, and destroy files at the
path. <br /> The directory in which the last path
component resides must already exist... create it
using NSFileManager if you need to.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSDistributedLock-lockDate">lockDate </a></h3>
- (<a rel="gsdoc" href="NSDate.html#class$NSDate">NSDate</a>*) <b>lockDate</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Returns the date at which the lock was acquired by
<em>any</em> NSDistributedLock using the same path. If
nothing has the lock, this returns <code>nil</code>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSDistributedLock-tryLock">tryLock </a></h3>
- (BOOL) <b>tryLock</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Attempt to acquire the lock and return
<code>YES</code> on success, <code>NO</code> on
failure. <br /> May raise an NSGenericException if
a problem occurs.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$NSDistributedLock-unlock">unlock </a></h3>
- (void) <b>unlock</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
Releases the lock. Raises an NSGenericException if
unable to release the lock (for instance if the
receiver does not own it or another process has
broken it).
</div>
<hr width="25%" align="left" />
</div>
<a name="_NSDistributedLock_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for NSDistributedLock Class</h2>
<h3><a name="ivariable$NSDistributedLock*_lockPath">_lockPath</a></h3>
@protected NSString* <b>_lockPath</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$NSDistributedLock*_lockTime">_lockTime</a></h3>
@protected NSDate* <b>_lockTime</b>;<br />
<div class="availability">
<b>Availability:</b> OpenStep</div>
<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<br />
<a href="Base.html">Up</a>
</font>
</body>
</html>
|