/usr/share/GNUstep/Documentation/Performance/GSThreadPool.html is in libperformance-dev 0.5.0-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 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 | <!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>GSThreadPool class documentation</title>
</head>
<body>
<font face="serif">
<h1><a name="title$GSThreadPool">GSThreadPool class documentation</a></h1>
<h3>Authors</h3>
<dl>
<dt>Richard Frith-Macdonald (<a href="mailto:rfm@gnu.org"><code>rfm@gnu.org</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 2010 Free Software Foundation, Inc.</p>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the GSThreadPool class
</a></h1>
<h2><a name="class$GSThreadPool">GSThreadPool</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GSThreadPool.h</dd>
</dl>
</blockquote>
<div class="desc">
This class provides a thread pool for performing methods
of objects in parallel in other threads. <br /> This is
similar to the NSOperationQueue class but is a
lightweight alternative designed to operate
rather faster though with slightly decreased
functionality... for instance there is no
dependency checking supported.
</div>
<hr width="50%" align="left" />
<a href="#_GSThreadPool_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool+sharedPool">+sharedPool</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-drain$">-drain:</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-flush">-flush</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-isEmpty">-isEmpty</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-isIdle">-isIdle</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-isSuspended">-isSuspended</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-maxOperations">-maxOperations</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-maxThreads">-maxThreads</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-resume">-resume</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-scheduleSelector$onReceiver$withObject$">-scheduleSelector:onReceiver:withObject:</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-setOperations$">-setOperations:</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-setThreads$">-setThreads:</a></li>
<li><a rel="gsdoc" href="GSThreadPool.html#method$GSThreadPool-suspend">-suspend</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSThreadPool+sharedPool">sharedPool </a></h3>
+ (<a rel="gsdoc" href="#class$GSThreadPool">GSThreadPool</a>*) <b>sharedPool</b>;<br />
<div class="desc">
Returns an instance intended for sharing between
sections of code which wish to make use of
threading by performing operations in other
threads, but which don't mind operations being
interleaved with those belonging to oither
sections of code. <br /> Always returns the same
instance whenever the method is called.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-drain$">drain: </a></h3>
- (BOOL) <b>drain:</b> (NSDate*)before;<br />
<div class="desc">
Waits until the pool of operations is empty or until
the specified timestamp. Returns <code>YES</code> if
the pool was emptied, <code>NO</code> otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-flush">flush </a></h3>
- (<a rel="gsdoc" href="GSLinkedList.html#type$NSUInteger">NSUInteger</a>) <b>flush</b>;<br />
<div class="desc">
Removes all operations which have not yet started,
returning a count of the abandoned operations.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-isEmpty">isEmpty </a></h3>
- (BOOL) <b>isEmpty</b>;<br />
<div class="desc">
Returns <code>YES</code> if no operations are
waiting to be performed, <code>NO</code> otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-isIdle">isIdle </a></h3>
- (BOOL) <b>isIdle</b>;<br />
<div class="desc">
Returns <code>YES</code> if <code>NO</code>
operations are in progress, <code>NO</code>
otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-isSuspended">isSuspended </a></h3>
- (BOOL) <b>isSuspended</b>;<br />
<div class="desc">
Returns <code>YES</code> if startup of new
operations is suspended, <code>NO</code>
otherwise.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-maxOperations">maxOperations </a></h3>
- (<a rel="gsdoc" href="GSLinkedList.html#type$NSUInteger">NSUInteger</a>) <b>maxOperations</b>;<br />
<div class="desc">
Returns the currently configured maximum number of
operations which may be scheduled at any one
time.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-maxThreads">maxThreads </a></h3>
- (<a rel="gsdoc" href="GSLinkedList.html#type$NSUInteger">NSUInteger</a>) <b>maxThreads</b>;<br />
<div class="desc">
Returns the currently configured maximum number of
threads in the pool.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-resume">resume </a></h3>
- (void) <b>resume</b>;<br />
<div class="desc">
Reverses the effect of
<a rel="gsdoc" href="#method$GSThreadPool-suspend">
-suspend
</a>
.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-scheduleSelector$onReceiver$withObject$">scheduleSelector: onReceiver: withObject: </a></h3>
- (void) <b>scheduleSelector:</b> (SEL)aSelector<b> onReceiver:</b> (NSObject*)aReceiver<b> withObject:</b> (NSObject*)anArgument;<br />
<div class="desc">
Adds the object to the queue for which operations
should be performed. <br /> You may add an object
more than once, but that may result in the operation
being performed simultaneously in more than one
thread. <br /> If the pool is configured with zero
threads or zero operations, this method will simply
perform the operation immediately. <br /> The
operation will be performed in a context where
there is an exception handler set to trap exceptions,
and an autorelease pool to deal with autoreleased
objects.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-setOperations$">setOperations: </a></h3>
- (void) <b>setOperations:</b> (<a rel="gsdoc" href="GSLinkedList.html#type$NSUInteger">NSUInteger</a>)max;<br />
<div class="desc">
Specify the number of operations which may be
waiting. <br /> Default is 100. <br /> Setting a
value of zero ensures that operations are performed
immediately rather than being queued.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-setThreads$">setThreads: </a></h3>
- (void) <b>setThreads:</b> (<a rel="gsdoc" href="GSLinkedList.html#type$NSUInteger">NSUInteger</a>)max;<br />
<div class="desc">
Specify the maximum number of threads in the pool
(the actual number used may be lower than this value).
<br /> Default is 2. <br /> The pool creates threads
on demand up to the specified limit (or a lower limit if
dictated by system resources) but will not destroy
idle threads unless the limit is subsequently
released. <br /> Setting a value of zero means
that operations are performed in the main thread. In
this case
<a rel="gsdoc" href="#method$GSThreadPool-drain$">
-drain:
</a>
will be used (with a 30 second limit) followed by
<a rel="gsdoc" href="#method$GSThreadPool-flush">
-flush
</a>
to ensure that the queue is emptied before the threads
are shut down.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSThreadPool-suspend">suspend </a></h3>
- (void) <b>suspend</b>;<br />
<div class="desc">
Turns off startup of new operations.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSThreadPool_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSThreadPool Class</h2>
<h3><a name="ivariable$GSThreadPool*idle">idle</a></h3>
@protected GSLinkedList* <b>idle</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*live">live</a></h3>
@protected GSLinkedList* <b>live</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*maxOperations">maxOperations</a></h3>
@protected NSUInteger <b>maxOperations</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*maxThreads">maxThreads</a></h3>
@protected NSUInteger <b>maxThreads</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*operations">operations</a></h3>
@protected GSLinkedList* <b>operations</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*poolLock">poolLock</a></h3>
@protected NSRecursiveLock* <b>poolLock</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*processed">processed</a></h3>
@protected NSUInteger <b>processed</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*shutdown">shutdown</a></h3>
@protected BOOL <b>shutdown</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*suspended">suspended</a></h3>
@protected BOOL <b>suspended</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSThreadPool*unused">unused</a></h3>
@protected GSLinkedList* <b>unused</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<br />
</font>
</body>
</html>
|