/usr/share/GNUstep/Documentation/Performance/GSTicker.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 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 | <!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>GSTicker class documentation</title>
</head>
<body>
<font face="serif">
<h1><a name="title$GSTicker">GSTicker 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>Version:</b> 33243</p>
<p><b>Date:</b> 2011-06-04 15:50:40 +0100 (Sat, 04 Jun 2011)</p>
<p><b>Copyright:</b> (C) 2005 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the GSTicker class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the GSTicker protocol</a>
</li>
<li>
<a href="#003000000000">GSTicker functions</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the GSTicker class
</a></h1>
<h2><a name="class$GSTicker">GSTicker</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GSTicker.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd><a rel="gsdoc" href="#protocol$(GSTicker)">GSTicker</a></dd>
</dl>
</blockquote>
<div class="desc">
Wrapper round the more efficient ticker functions...
this class provides convenience methods to get NSDate
objects, and also provides support for registering
observers ofr second by second ticks.
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker+last">+last</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker+newSecond$">+newSecond:</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker+now">+now</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker+registerObserver$userInfo$">+registerObserver:userInfo:</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker+start">+start</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker+tick">+tick</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker+unregisterObserver$">+unregisterObserver:</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker+update">+update</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker-last">-last</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker-newSecond$">-newSecond:</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker-now">-now</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker-start">-start</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker-tick">-tick</a></li>
<li><a rel="gsdoc" href="GSTicker.html#method$GSTicker-update">-update</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSTicker+last">last </a></h3>
+ (NSDate*) <b>last</b>;<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#function$GSTickerTimeLast">
GSTickerTimeLast()
</a>
and returns the result as an NSDate.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker+newSecond$">newSecond: </a></h3>
+ (void) <b>newSecond:</b> (id)userInfo;<br />
<div class="desc">
A dummy method... does nothing, but allows the GSTicker
class itsself to act as an observer of regular
timeouts. <br /> Thus, you may register the class
as its own observer in order to set up a timer to ensure
that date/time information is updated at the start of
every second.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker+now">now </a></h3>
+ (NSDate*) <b>now</b>;<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#function$GSTickerTimeNow">
GSTickerTimeNow()
</a>
and returns the result as an NSDate.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker+registerObserver$userInfo$">registerObserver: userInfo: </a></h3>
+ (void) <b>registerObserver:</b> (id<<a rel="gsdoc" href="#protocol$(GSTicker)">GSTicker</a>>)anObject<b> userInfo:</b> (id)userInfo;<br />
<div class="desc">
Registers an object to receive a
<a rel="gsdoc" href="#method$(GSTicker)-newSecond$">
[<GSTicker>-newSecond:]
</a>
message at the start of every second. <br /> Also
starts a timer in the current thread (unless one is
already running) to notify registered objects of
new seconds. <br /> The observer and the
<var>userInfo</var> are retained by the ticker.
<br /> Adding an observer more than once has no
effect. <br /> NB. You must not add or remove
observers inside the callback routine.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker+start">start </a></h3>
+ (NSDate*) <b>start</b>;<br />
<div class="desc">
Returns the result of
<a rel="gsdoc" href="#function$GSTickerTimeStart">
GSTickerTimeStart()
</a>
as an NSDate.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker+tick">tick </a></h3>
+ (unsigned) <b>tick</b>;<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#function$GSTickerTimeTick">
GSTickerTimeTick()
</a>
and returns the result.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker+unregisterObserver$">unregisterObserver: </a></h3>
+ (void) <b>unregisterObserver:</b> (id<<a rel="gsdoc" href="#protocol$(GSTicker)">GSTicker</a>>)anObject;<br />
<div class="desc">
Unregisters an observer previously set in the
current thread using the
<a rel="gsdoc" href="#method$GSTicker+registerObserver$userInfo$">
+registerObserver:userInfo:
</a>
method. <br /> If all observers in a thread are
removed, the timer for the thread is cancelled at
the start of the next second.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker+update">update </a></h3>
+ (void) <b>update</b>;<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#function$GSTickerTimeNow">
GSTickerTimeNow()
</a>
;
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker-last">last </a></h3>
- (NSDate*) <b>last</b>;<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#function$GSTickerTimeLast">
GSTickerTimeLast()
</a>
and returns the result as an NSDate.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker-newSecond$">newSecond: </a></h3>
- (void) <b>newSecond:</b> (id)userInfo;<br />
<div class="desc">
See
<a rel="gsdoc" href="#method$GSTicker+newSecond$">
+newSecond:
</a>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker-now">now </a></h3>
- (NSDate*) <b>now</b>;<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#function$GSTickerTimeNow">
GSTickerTimeNow()
</a>
and returns the result as an NSDate.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker-start">start </a></h3>
- (NSDate*) <b>start</b>;<br />
<div class="desc">
Returns the result of
<a rel="gsdoc" href="#function$GSTickerTimeStart">
GSTickerTimeStart()
</a>
as an NSDate.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker-tick">tick </a></h3>
- (unsigned) <b>tick</b>;<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#function$GSTickerTimeTick">
GSTickerTimeTick()
</a>
and returns the result.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSTicker-update">update </a></h3>
- (void) <b>update</b>;<br />
<div class="desc">
Calls
<a rel="gsdoc" href="#function$GSTickerTimeNow">
GSTickerTimeNow()
</a>
;
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="002000000000">
Software documentation for the GSTicker protocol
</a></h1>
<h2><a name="protocol$(GSTicker)">GSTicker</a></h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GSTicker.h</dd>
</dl>
</blockquote>
<blockquote>
<dl>
<dt><b>Conforms to:</b></dt>
<dd>NSObject</dd>
</dl>
</blockquote>
<div class="desc">
<em>Description forthcoming.</em>
</div>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSTicker.html#method$(GSTicker)-newSecond$">-newSecond:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$(GSTicker)-newSecond$">newSecond: </a></h3>
- (void) <b>newSecond:</b> (id)userInfo;<br />
<div class="desc">
Sent to tell observers that the ticker has noticed
that a new second has occurred. The tick argument is
the user information provided in when registering the
observer. <br /> This message is sent to each
registered observer when the timeout for the
thread occurs. It is not guaranteed to be called
every second... other processing in the thread may
delay it.
</div>
<hr width="25%" align="left" />
</div>
<h1><a name="003000000000">GSTicker functions</a></h1>
<p>
</p>
<h3><a name="function$GSTickerTimeLast">GSTickerTimeLast</a></h3>
NSTimeInterval GSTickerTimeLast();<br />
<div class="desc">
Returns the timestamp of the most recent call to
<a rel="gsdoc" href="#function$GSTickerTimeNow">
GSTickerTimeNow()
</a>
.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSTickerTimeNow">GSTickerTimeNow</a></h3>
NSTimeInterval GSTickerTimeNow();<br />
<div class="desc">
Convenience function to provide timing
information quickly. <br /> This returns the
current date/time, and stores the value for use by
the
<a rel="gsdoc" href="#function$GSTickerTimeLast">
GSTickerTimeLast()
</a>
function.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSTickerTimeStart">GSTickerTimeStart</a></h3>
NSTimeInterval GSTickerTimeStart();<br />
<div class="desc">
This returns the timestamp from which GSTicker was first
used.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSTickerTimeTick">GSTickerTimeTick</a></h3>
unsigned int GSTickerTimeTick();<br />
<div class="desc">
A convenience method to return the current clock 'tick'...
which is the current second based on the time we
started. This does <em>not</em> check the current
time, but relies on
<a rel="gsdoc" href="#function$GSTickerTimeLast">
GSTickerTimeLast()
</a>
returning an up to date value (so if you need an
accurate tick, you should ensure that
<a rel="gsdoc" href="#function$GSTickerTimeNow">
GSTickerTimeNow()
</a>
is called at least once a second). <br /> The returned
value is always greater than zero, and is basically
calculated as (GSTickerTimeLast() -
<a rel="gsdoc" href="#function$GSTickerTimeStart">
GSTickerTimeStart()
</a>
+ 1). <br /> In the event that the system clock is reset
into the past, the value of
<a rel="gsdoc" href="#function$GSTickerTimeStart">
GSTickerTimeStart()
</a>
is automatically adjusted to ensure that the result of a
call to
<a rel="gsdoc" href="#function$GSTickerTimeTick">
GSTickerTimeTick()
</a>
is never less than the result of any earlier call to the
function.
</div>
<hr width="25%" align="left" />
<br />
</font>
</body>
</html>
|