| ︙ | | |
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
|
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
|
-
+
-
+
-
+
-
+
-
+
-
+
-
+
|
#ifdef OF_HAVE_BLOCKS
/**
* @brief A block to execute when a timer fires.
*
* @param timer The timer which fired
*/
typedef void (^of_timer_block_t)(OFTimer *timer);
typedef void (^OFTimerBlock)(OFTimer *timer);
#endif
/**
* @class OFTimer OFTimer.h ObjFW/OFTimer.h
*
* @brief A class for creating and firing timers.
*/
OF_SUBCLASSING_RESTRICTED
@interface OFTimer: OFObject <OFComparing>
{
OFDate *_fireDate;
of_time_interval_t _interval;
OFTimeInterval _interval;
id _target;
id _Nullable _object1, _object2, _object3, _object4;
SEL _selector;
unsigned char _arguments;
bool _repeats;
#ifdef OF_HAVE_BLOCKS
of_timer_block_t _block;
OFTimerBlock _block;
#endif
bool _valid;
#ifdef OF_HAVE_THREADS
OFCondition *_condition;
bool _done;
#endif
OFRunLoop *_Nullable _inRunLoop;
of_run_loop_mode_t _Nullable _inRunLoopMode;
OFRunLoopMode _Nullable _inRunLoopMode;
}
/**
* @brief The time interval in which the timer will repeat, if it is a
* repeating timer.
*/
@property (readonly, nonatomic) of_time_interval_t timeInterval;
@property (readonly, nonatomic) OFTimeInterval timeInterval;
/**
* @brief Whether the timer is repeating.
* @brief Whether the timer repeats.
*/
@property (readonly, nonatomic, getter=isRepeating) bool repeating;
@property (readonly, nonatomic) bool repeats;
/**
* @brief Whether the timer is valid.
*/
@property (readonly, nonatomic, getter=isValid) bool valid;
/**
|
| ︙ | | |
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
|
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
|
-
+
-
+
-
+
|
*
* @param timeInterval The time interval after which the timer should be fired
* @param target The target on which to call the selector
* @param selector The selector to call on the target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)scheduledTimerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
repeats: (bool)repeats;
/**
* @brief Creates and schedules a new timer with the specified time interval.
*
* @param timeInterval The time interval after which the timer should be fired
* @param target The target on which to call the selector
* @param selector The selector to call on the target
* @param object An object to pass when calling the selector on the target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)scheduledTimerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
object: (nullable id)object
repeats: (bool)repeats;
/**
* @brief Creates and schedules a new timer with the specified time interval.
*
* @param timeInterval The time interval after which the timer should be fired
* @param target The target on which to call the selector
* @param selector The selector to call on the target
* @param object1 The first object to pass when calling the selector on the
* target
* @param object2 The second object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)scheduledTimerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
repeats: (bool)repeats;
/**
|
| ︙ | | |
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
|
-
+
|
* @param object2 The second object to pass when calling the selector on the
* target
* @param object3 The third object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)scheduledTimerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
object: (nullable id)object3
repeats: (bool)repeats;
|
| ︙ | | |
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
|
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
|
-
+
-
+
-
+
-
+
-
+
-
+
|
* @param object3 The third object to pass when calling the selector on the
* target
* @param object4 The fourth object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)scheduledTimerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
object: (nullable id)object3
object: (nullable id)object4
repeats: (bool)repeats;
#ifdef OF_HAVE_BLOCKS
/**
* @brief Creates and schedules a new timer with the specified time interval.
*
* @param timeInterval The time interval after which the timer should be fired
* @param repeats Whether the timer repeats after it has been executed
* @param block The block to invoke when the timer fires
* @return A new, autoreleased timer
*/
+ (instancetype)scheduledTimerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)scheduledTimerWithTimeInterval: (OFTimeInterval)timeInterval
repeats: (bool)repeats
block: (of_timer_block_t)block;
block: (OFTimerBlock)block;
#endif
/**
* @brief Creates a new timer with the specified time interval.
*
* @param timeInterval The time interval after which the timer should be fired
* @param target The target on which to call the selector
* @param selector The selector to call on the target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)timerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
repeats: (bool)repeats;
/**
* @brief Creates a new timer with the specified time interval.
*
* @param timeInterval The time interval after which the timer should be fired
* @param target The target on which to call the selector
* @param selector The selector to call on the target
* @param object An object to pass when calling the selector on the target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)timerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
object: (nullable id)object
repeats: (bool)repeats;
/**
* @brief Creates a new timer with the specified time interval.
*
* @param timeInterval The time interval after which the timer should be fired
* @param target The target on which to call the selector
* @param selector The selector to call on the target
* @param object1 The first object to pass when calling the selector on the
* target
* @param object2 The second object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)timerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
repeats: (bool)repeats;
/**
|
| ︙ | | |
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
|
-
+
|
* @param object2 The second object to pass when calling the selector on the
* target
* @param object3 The third object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)timerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
object: (nullable id)object3
repeats: (bool)repeats;
|
| ︙ | | |
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
|
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
|
-
+
-
+
-
+
-
+
-
+
|
* @param object3 The third object to pass when calling the selector on the
* target
* @param object4 The fourth object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return A new, autoreleased timer
*/
+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)timerWithTimeInterval: (OFTimeInterval)timeInterval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
object: (nullable id)object3
object: (nullable id)object4
repeats: (bool)repeats;
#ifdef OF_HAVE_BLOCKS
/**
* @brief Creates a new timer with the specified time interval.
*
* @param timeInterval The time interval after which the timer should be fired
* @param repeats Whether the timer repeats after it has been executed
* @param block The block to invoke when the timer fires
* @return A new, autoreleased timer
*/
+ (instancetype)timerWithTimeInterval: (of_time_interval_t)timeInterval
+ (instancetype)timerWithTimeInterval: (OFTimeInterval)timeInterval
repeats: (bool)repeats
block: (of_timer_block_t)block;
block: (OFTimerBlock)block;
#endif
- (instancetype)init OF_UNAVAILABLE;
/**
* @brief Initializes an already allocated timer with the specified time
* interval.
*
* @param fireDate The date at which the timer should fire
* @param interval The time interval after which to repeat the timer, if it is
* a repeating timer
* @param target The target on which to call the selector
* @param selector The selector to call on the target
* @param repeats Whether the timer repeats after it has been executed
* @return An initialized timer
*/
- (instancetype)initWithFireDate: (OFDate *)fireDate
interval: (of_time_interval_t)interval
interval: (OFTimeInterval)interval
target: (id)target
selector: (SEL)selector
repeats: (bool)repeats;
/**
* @brief Initializes an already allocated timer with the specified time
* interval.
*
* @param fireDate The date at which the timer should fire
* @param interval The time interval after which to repeat the timer, if it is
* a repeating timer
* @param target The target on which to call the selector
* @param selector The selector to call on the target
* @param object An object to pass when calling the selector on the target
* @param repeats Whether the timer repeats after it has been executed
* @return An initialized timer
*/
- (instancetype)initWithFireDate: (OFDate *)fireDate
interval: (of_time_interval_t)interval
interval: (OFTimeInterval)interval
target: (id)target
selector: (SEL)selector
object: (nullable id)object
repeats: (bool)repeats;
/**
* @brief Initializes an already allocated timer with the specified time
|
| ︙ | | |
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
|
-
+
|
* target
* @param object2 The second object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return An initialized timer
*/
- (instancetype)initWithFireDate: (OFDate *)fireDate
interval: (of_time_interval_t)interval
interval: (OFTimeInterval)interval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
repeats: (bool)repeats;
/**
|
| ︙ | | |
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
|
-
+
|
* target
* @param object3 The third object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return An initialized timer
*/
- (instancetype)initWithFireDate: (OFDate *)fireDate
interval: (of_time_interval_t)interval
interval: (OFTimeInterval)interval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
object: (nullable id)object3
repeats: (bool)repeats;
|
| ︙ | | |
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
|
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
|
-
+
|
* target
* @param object4 The fourth object to pass when calling the selector on the
* target
* @param repeats Whether the timer repeats after it has been executed
* @return An initialized timer
*/
- (instancetype)initWithFireDate: (OFDate *)fireDate
interval: (of_time_interval_t)interval
interval: (OFTimeInterval)interval
target: (id)target
selector: (SEL)selector
object: (nullable id)object1
object: (nullable id)object2
object: (nullable id)object3
object: (nullable id)object4
repeats: (bool)repeats;
|
| ︙ | | |
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
|
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
|
-
+
-
+
+
+
+
+
+
+
+
+
|
* @param interval The time interval after which to repeat the timer, if it is
* a repeating timer
* @param repeats Whether the timer repeats after it has been executed
* @param block The block to invoke when the timer fires
* @return An initialized timer
*/
- (instancetype)initWithFireDate: (OFDate *)fireDate
interval: (of_time_interval_t)interval
interval: (OFTimeInterval)interval
repeats: (bool)repeats
block: (of_timer_block_t)block;
block: (OFTimerBlock)block;
#endif
/**
* @brief Compares the timer to another timer.
*
* @param timer The timer to compare the string to
* @return The result of the comparison
*/
- (OFComparisonResult)compare: (OFTimer *)timer;
/**
* @brief Fires the timer, meaning it will execute the specified selector on the
* target.
*/
- (void)fire;
/**
|
| ︙ | | |