A class for creating and firing timers. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFTimer:

Instance Methods
(instancetype)	- initWithFireDate:interval:target:selector:repeats:
	Initializes an already allocated timer with the specified time interval.

(instancetype)	- initWithFireDate:interval:target:selector:object:repeats:
	Initializes an already allocated timer with the specified time interval.

(instancetype)	- initWithFireDate:interval:target:selector:object:object:repeats:
	Initializes an already allocated timer with the specified time interval.

(instancetype)	- initWithFireDate:interval:target:selector:object:object:object:repeats:
	Initializes an already allocated timer with the specified time interval.

(instancetype)	- initWithFireDate:interval:target:selector:object:object:object:object:repeats:
	Initializes an already allocated timer with the specified time interval.

(instancetype)	- initWithFireDate:interval:repeats:block:
	Initializes an already allocated timer with the specified time interval.

(OFComparisonResult)	- compare:
	Compares the timer to another timer.

(void)	- fire
	Fires the timer without changing its regular schedule.

(void)	- invalidate
	Invalidates the timer, preventing it from firing.

(void)	- waitUntilDone
	Waits until the timer fired.

Instance Methods inherited from OFObject
(instancetype)	- init
	Initializes an already allocated object.

(nullable OFMethodSignature *)	- methodSignatureForSelector:
	Returns the method signature for the specified selector.

(void)	- dealloc
	Deallocates the object.

(void)	- performSelector:afterDelay:
	Performs the specified selector after the specified delay.

(void)	- performSelector:withObject:afterDelay:
	Performs the specified selector with the specified object after the specified delay.

(void)	- performSelector:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector with the specified objects after the specified delay.

(void)	- performSelector:onThread:waitUntilDone:
	Performs the specified selector on the specified thread.

(void)	- performSelector:onThread:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified object.

(void)	- performSelector:onThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the specified thread with the specified objects.

(void)	- performSelectorOnMainThread:waitUntilDone:
	Performs the specified selector on the main thread.

(void)	- performSelectorOnMainThread:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified object.

(void)	- performSelectorOnMainThread:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelectorOnMainThread:withObject:withObject:withObject:withObject:waitUntilDone:
	Performs the specified selector on the main thread with the specified objects.

(void)	- performSelector:onThread:afterDelay:
	Performs the specified selector on the specified thread after the specified delay.

(void)	- performSelector:onThread:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified object after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(void)	- performSelector:onThread:withObject:withObject:withObject:withObject:afterDelay:
	Performs the specified selector on the specified thread with the specified objects after the specified delay.

(nullable id)	- forwardingTargetForSelector:
	This method is called when resolveClassMethod: or resolveInstanceMethod: returned false. It should return a target to which the message should be forwarded.

(void)	- doesNotRecognizeSelector:
	Handles messages which are not understood by the receiver.

Instance Methods inherited from <OFObject>
(unsigned long)	- hash
	Returns a hash for the object.

(unsigned int)	- retainCount
	Returns the retain count.

(bool)	- isProxy
	Returns whether the object is a proxy object.

(bool)	- isKindOfClass:
	Returns a boolean whether the object is of the specified kind.

(bool)	- isMemberOfClass:
	Returns a boolean whether the object is a member of the specified class.

(bool)	- respondsToSelector:
	Returns a boolean whether the object responds to the specified selector.

(nullable IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(nullable id)	- performSelector:
	Performs the specified selector.

(nullable id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(nullable id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(nullable id)	- performSelector:withObject:withObject:withObject:withObject:
	Performs the specified selector with the specified objects.

(bool)	- isEqual:
	Checks two objects for equality.

(instancetype)	- retain
	Increases the retain count.

(void)	- release
	Decreases the retain count.

(instancetype)	- autorelease
	Adds the object to the topmost autorelease pool of the thread's autorelease pool stack.

(instancetype)	- self
	Returns the receiver.

(bool)	- allowsWeakReference
	Returns whether the object allows a weak reference.

(bool)	- retainWeakReference
	Retain a weak reference to this object.

Instance Methods inherited from <OFComparing>
(OFComparisonResult)	- compare:
	Compares the object to another object.

Class Methods
(instancetype)	+ scheduledTimerWithTimeInterval:target:selector:repeats:
	Creates and schedules a new timer with the specified time interval.

(instancetype)	+ scheduledTimerWithTimeInterval:target:selector:object:repeats:
	Creates and schedules a new timer with the specified time interval.

(instancetype)	+ scheduledTimerWithTimeInterval:target:selector:object:object:repeats:
	Creates and schedules a new timer with the specified time interval.

(instancetype)	+ scheduledTimerWithTimeInterval:target:selector:object:object:object:repeats:
	Creates and schedules a new timer with the specified time interval.

(instancetype)	+ scheduledTimerWithTimeInterval:target:selector:object:object:object:object:repeats:
	Creates and schedules a new timer with the specified time interval.

(instancetype)	+ scheduledTimerWithTimeInterval:repeats:block:
	Creates and schedules a new timer with the specified time interval.

(instancetype)	+ timerWithTimeInterval:target:selector:repeats:
	Creates a new timer with the specified time interval.

(instancetype)	+ timerWithTimeInterval:target:selector:object:repeats:
	Creates a new timer with the specified time interval.

(instancetype)	+ timerWithTimeInterval:target:selector:object:object:repeats:
	Creates a new timer with the specified time interval.

(instancetype)	+ timerWithTimeInterval:target:selector:object:object:object:repeats:
	Creates a new timer with the specified time interval.

(instancetype)	+ timerWithTimeInterval:target:selector:object:object:object:object:repeats:
	Creates a new timer with the specified time interval.

(instancetype)	+ timerWithTimeInterval:repeats:block:
	Creates a new timer with the specified time interval.

Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.

(void)	+ unload
	A method which is called when the class is unloaded from the runtime.

(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(instancetype)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(Class)	+ class
	Returns the class.

(OFString *)	+ className
	Returns the name of the class as a string.

(bool)	+ isSubclassOfClass:
	Returns a boolean whether the class is a subclass of the specified class.

(nullable Class)	+ superclass
	Returns the superclass of the class.

(bool)	+ instancesRespondToSelector:
	Checks whether instances of the class respond to a given selector.

(bool)	+ conformsToProtocol:
	Checks whether the class conforms to a given protocol.

(nullable IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(nullable OFMethodSignature *)	+ instanceMethodSignatureForSelector:
	Returns the method signature of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(nullable IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(nullable IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(void)	+ inheritMethodsFromClass:
	Adds all methods from the specified class to the class that is the receiver.

(bool)	+ resolveClassMethod:
	Try to resolve the specified class method.

(bool)	+ resolveInstanceMethod:
	Try to resolve the specified instance method.

(id)	+ copy
	Returns the class.

Properties
OFTimeInterval	timeInterval
	The time interval in which the timer will repeat, if it is a repeating timer.

bool	repeats
	Whether the timer repeats.

bool	valid
	Whether the timer is valid.

OFDate *	fireDate
	The next date at which the timer will fire.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Detailed Description

A class for creating and firing timers.

Method Documentation

◆ compare:

- (OFComparisonResult) compare: (OFTimer *) timer

Compares the timer to another timer.

Parameters

timer The timer to compare the string to

Returns: The result of the comparison

◆ fire

- (void) fire

Fires the timer without changing its regular schedule.

A non-repeating timer will be invalidated after firing.

◆ initWithFireDate:interval:repeats:block:

- (instancetype) initWithFireDate:	(OFDate *)	fireDate
interval:	(OFTimeInterval)	interval
repeats:	(bool)	repeats
block:	(OFTimerBlock)	block

Initializes an already allocated timer with the specified time interval.

Parameters

fireDate	The date at which the timer should fire
interval	The time interval after which to repeat the timer, if it is a repeating timer
repeats	Whether the timer repeats after it has been executed
block	The block to invoke when the timer fires

Returns: An initialized timer

◆ initWithFireDate:interval:target:selector:object:object:object:object:repeats:

- (instancetype) initWithFireDate:	(OFDate *)	fireDate
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

Initializes an already allocated timer with the specified time interval.

Parameters

fireDate	The date at which the timer should fire
interval	The time interval after which to repeat the timer, if it is a repeating timer
target	The target on which to call the selector
selector	The selector to call on the target
object1	The first object to pass when calling the selector on the target
object2	The second object to pass when calling the selector on the target
object3	The third object to pass when calling the selector on the target
object4	The fourth object to pass when calling the selector on the target
repeats	Whether the timer repeats after it has been executed

Returns: An initialized timer

◆ initWithFireDate:interval:target:selector:object:object:object:repeats:

- (instancetype) initWithFireDate:	(OFDate *)	fireDate
interval:	(OFTimeInterval)	interval
target:	(id)	target
selector:	(SEL)	selector
object:	(nullable id)	object1
object:	(nullable id)	object2
object:	(nullable id)	object3
repeats:	(bool)	repeats

Initializes an already allocated timer with the specified time interval.

Parameters

fireDate	The date at which the timer should fire
interval	The time interval after which to repeat the timer, if it is a repeating timer
target	The target on which to call the selector
selector	The selector to call on the target
object1	The first object to pass when calling the selector on the target
object2	The second object to pass when calling the selector on the target
object3	The third object to pass when calling the selector on the target
repeats	Whether the timer repeats after it has been executed

Returns: An initialized timer

◆ initWithFireDate:interval:target:selector:object:object:repeats:

- (instancetype) initWithFireDate:	(OFDate *)	fireDate
interval:	(OFTimeInterval)	interval
target:	(id)	target
selector:	(SEL)	selector
object:	(nullable id)	object1
object:	(nullable id)	object2
repeats:	(bool)	repeats

Initializes an already allocated timer with the specified time interval.

Parameters

fireDate	The date at which the timer should fire
interval	The time interval after which to repeat the timer, if it is a repeating timer
target	The target on which to call the selector
selector	The selector to call on the target
object1	The first object to pass when calling the selector on the target
object2	The second object to pass when calling the selector on the target
repeats	Whether the timer repeats after it has been executed

Returns: An initialized timer

◆ initWithFireDate:interval:target:selector:object:repeats:

- (instancetype) initWithFireDate:	(OFDate *)	fireDate
interval:	(OFTimeInterval)	interval
target:	(id)	target
selector:	(SEL)	selector
object:	(nullable id)	object
repeats:	(bool)	repeats

Initializes an already allocated timer with the specified time interval.

Parameters

fireDate	The date at which the timer should fire
interval	The time interval after which to repeat the timer, if it is a repeating timer
target	The target on which to call the selector
selector	The selector to call on the target
object	An object to pass when calling the selector on the target
repeats	Whether the timer repeats after it has been executed

Returns: An initialized timer

◆ initWithFireDate:interval:target:selector:repeats:

- (instancetype) initWithFireDate:	(OFDate *)	fireDate
interval:	(OFTimeInterval)	interval
target:	(id)	target
selector:	(SEL)	selector
repeats:	(bool)	repeats

Initializes an already allocated timer with the specified time interval.

Parameters

fireDate	The date at which the timer should fire
interval	The time interval after which to repeat the timer, if it is a repeating timer
target	The target on which to call the selector
selector	The selector to call on the target
repeats	Whether the timer repeats after it has been executed

Returns: An initialized timer

◆ scheduledTimerWithTimeInterval:repeats:block:

+ (instancetype) scheduledTimerWithTimeInterval:	(OFTimeInterval)	timeInterval
repeats:	(bool)	repeats
block:	(OFTimerBlock)	block

Creates and schedules a new timer with the specified time interval.

Parameters

timeInterval	The time interval after which the timer should be fired
repeats	Whether the timer repeats after it has been executed
block	The block to invoke when the timer fires

Returns: A new, autoreleased timer

◆ scheduledTimerWithTimeInterval:target:selector:object:object:object:object:repeats:

+ (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

Creates and schedules a new timer with the specified time interval.

Parameters

timeInterval	The time interval after which the timer should be fired
target	The target on which to call the selector
selector	The selector to call on the target
object1	The first object to pass when calling the selector on the target
object2	The second object to pass when calling the selector on the target
object3	The third object to pass when calling the selector on the target
object4	The fourth object to pass when calling the selector on the target
repeats	Whether the timer repeats after it has been executed

Returns: A new, autoreleased timer

◆ scheduledTimerWithTimeInterval:target:selector:object:object:object:repeats:

+ (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

Creates and schedules a new timer with the specified time interval.

Parameters

timeInterval	The time interval after which the timer should be fired
target	The target on which to call the selector
selector	The selector to call on the target
object1	The first object to pass when calling the selector on the target
object2	The second object to pass when calling the selector on the target
object3	The third object to pass when calling the selector on the target
repeats	Whether the timer repeats after it has been executed

Returns: A new, autoreleased timer

◆ scheduledTimerWithTimeInterval:target:selector:object:object:repeats:

+ (instancetype) scheduledTimerWithTimeInterval:	(OFTimeInterval)	timeInterval
target:	(id)	target
selector:	(SEL)	selector
object:	(nullable id)	object1
object:	(nullable id)	object2
repeats:	(bool)	repeats

Creates and schedules a new timer with the specified time interval.

Parameters

timeInterval	The time interval after which the timer should be fired
target	The target on which to call the selector
selector	The selector to call on the target
object1	The first object to pass when calling the selector on the target
object2	The second object to pass when calling the selector on the target
repeats	Whether the timer repeats after it has been executed

Returns: A new, autoreleased timer

◆ scheduledTimerWithTimeInterval:target:selector:object:repeats:

+ (instancetype) scheduledTimerWithTimeInterval:	(OFTimeInterval)	timeInterval
target:	(id)	target
selector:	(SEL)	selector
object:	(nullable id)	object
repeats:	(bool)	repeats

Creates and schedules a new timer with the specified time interval.

Parameters

timeInterval	The time interval after which the timer should be fired
target	The target on which to call the selector
selector	The selector to call on the target
object	An object to pass when calling the selector on the target
repeats	Whether the timer repeats after it has been executed

Returns: A new, autoreleased timer

◆ scheduledTimerWithTimeInterval:target:selector:repeats:

+ (instancetype) scheduledTimerWithTimeInterval:	(OFTimeInterval)	timeInterval
target:	(id)	target
selector:	(SEL)	selector
repeats:	(bool)	repeats

Creates and schedules a new timer with the specified time interval.

Parameters

timeInterval	The time interval after which the timer should be fired
target	The target on which to call the selector
selector	The selector to call on the target
repeats	Whether the timer repeats after it has been executed

Returns: A new, autoreleased timer