/usr/share/GNUstep/Documentation/Performance/GSTicker.gsdoc 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 | <?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN" "http://www.gnustep.org/gsdoc-1_0_3.dtd">
<gsdoc base="GSTicker">
<head>
<title>GSTicker class documentation</title>
<author name="Richard Frith-Macdonald">
<email address="rfm@gnu.org">
rfm@gnu.org
</email>
</author>
<version>33243</version>
<date>2011-06-04 15:50:40 +0100 (Sat, 04 Jun 2011)</date>
<copy>2005 Free Software Foundation, Inc.</copy>
</head>
<body>
<front><contents /></front>
<chapter>
<heading>
Software documentation for the GSTicker class
</heading>
<class name="GSTicker" super="NSObject">
<declared>GSTicker.h</declared>
<conform>GSTicker</conform>
<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.
</desc>
<method type="NSDate*" factory="yes">
<sel>last</sel>
<desc>
Calls
<ref type="function" id="GSTickerTimeLast">
GSTickerTimeLast()
</ref>
and returns the result as an NSDate.
</desc>
</method>
<method type="void" factory="yes">
<sel>newSecond:</sel>
<arg type="id">userInfo</arg>
<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.
</desc>
</method>
<method type="NSDate*" factory="yes">
<sel>now</sel>
<desc>
Calls
<ref type="function" id="GSTickerTimeNow">
GSTickerTimeNow()
</ref>
and returns the result as an NSDate.
</desc>
</method>
<method type="void" factory="yes">
<sel>registerObserver:</sel>
<arg type="id<GSTicker>">anObject</arg>
<sel>userInfo:</sel>
<arg type="id">userInfo</arg>
<desc>
Registers an object to receive a
<ref type="method" id="-newSecond:" class="(GSTicker)">
[<GSTicker>-newSecond:]
</ref>
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.
</desc>
</method>
<method type="NSDate*" factory="yes">
<sel>start</sel>
<desc>
Returns the result of
<ref type="function" id="GSTickerTimeStart">
GSTickerTimeStart()
</ref>
as an NSDate.
</desc>
</method>
<method type="unsigned" factory="yes">
<sel>tick</sel>
<desc>
Calls
<ref type="function" id="GSTickerTimeTick">
GSTickerTimeTick()
</ref>
and returns the result.
</desc>
</method>
<method type="void" factory="yes">
<sel>unregisterObserver:</sel>
<arg type="id<GSTicker>">anObject</arg>
<desc>
Unregisters an observer previously set in the
current thread using the
<ref type="method" id="+registerObserver:userInfo:">
+registerObserver:userInfo:
</ref>
method. <br /> If all observers in a thread are
removed, the timer for the thread is cancelled at
the start of the next second.
</desc>
</method>
<method type="void" factory="yes">
<sel>update</sel>
<desc>
Calls
<ref type="function" id="GSTickerTimeNow">
GSTickerTimeNow()
</ref>
;
</desc>
</method>
<method type="NSDate*">
<sel>last</sel>
<desc>
Calls
<ref type="function" id="GSTickerTimeLast">
GSTickerTimeLast()
</ref>
and returns the result as an NSDate.
</desc>
</method>
<method type="void">
<sel>newSecond:</sel>
<arg type="id">userInfo</arg>
<desc>
See
<ref type="method" id="+newSecond:">
+newSecond:
</ref>
</desc>
</method>
<method type="NSDate*">
<sel>now</sel>
<desc>
Calls
<ref type="function" id="GSTickerTimeNow">
GSTickerTimeNow()
</ref>
and returns the result as an NSDate.
</desc>
</method>
<method type="NSDate*">
<sel>start</sel>
<desc>
Returns the result of
<ref type="function" id="GSTickerTimeStart">
GSTickerTimeStart()
</ref>
as an NSDate.
</desc>
</method>
<method type="unsigned">
<sel>tick</sel>
<desc>
Calls
<ref type="function" id="GSTickerTimeTick">
GSTickerTimeTick()
</ref>
and returns the result.
</desc>
</method>
<method type="void">
<sel>update</sel>
<desc>
Calls
<ref type="function" id="GSTickerTimeNow">
GSTickerTimeNow()
</ref>
;
</desc>
</method>
</class>
</chapter>
<chapter>
<heading>
Software documentation for the GSTicker protocol
</heading>
<protocol name="GSTicker">
<declared>GSTicker.h</declared>
<conform>NSObject</conform>
<desc>
<em>Description forthcoming.</em>
</desc>
<method type="void">
<sel>newSecond:</sel>
<arg type="id">userInfo</arg>
<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.
</desc>
</method>
</protocol>
</chapter>
<chapter>
<heading>GSTicker functions</heading>
<p></p>
<function type="NSTimeInterval" name="GSTickerTimeLast">
<desc>
Returns the timestamp of the most recent call to
<ref type="function" id="GSTickerTimeNow">
GSTickerTimeNow()
</ref>
.
</desc>
</function>
<function type="NSTimeInterval" name="GSTickerTimeNow">
<desc>
Convenience function to provide timing
information quickly. <br /> This returns the
current date/time, and stores the value for use by
the
<ref type="function" id="GSTickerTimeLast">
GSTickerTimeLast()
</ref>
function.
</desc>
</function>
<function type="NSTimeInterval" name="GSTickerTimeStart">
<desc>
This returns the timestamp from which GSTicker was first
used.
</desc>
</function>
<function type="unsigned int" name="GSTickerTimeTick">
<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
<ref type="function" id="GSTickerTimeLast">
GSTickerTimeLast()
</ref>
returning an up to date value (so if you need an
accurate tick, you should ensure that
<ref type="function" id="GSTickerTimeNow">
GSTickerTimeNow()
</ref>
is called at least once a second). <br /> The returned
value is always greater than zero, and is basically
calculated as (GSTickerTimeLast() -
<ref type="function" id="GSTickerTimeStart">
GSTickerTimeStart()
</ref>
+ 1). <br /> In the event that the system clock is reset
into the past, the value of
<ref type="function" id="GSTickerTimeStart">
GSTickerTimeStart()
</ref>
is automatically adjusted to ensure that the result of a
call to
<ref type="function" id="GSTickerTimeTick">
GSTickerTimeTick()
</ref>
is never less than the result of any earlier call to the
function.
</desc>
</function>
</chapter>
</body>
</gsdoc>
|