OFTimer Class Reference

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

#import <OFTimer.h>

Inheritance diagram for OFTimer:

Instance Methods
(id)	- initWithFireDate:interval:target:selector:repeats:
	Initializes an already allocated timer with the specified time interval.
(id)	- initWithFireDate:interval:target:selector:object:repeats:
	Initializes an already allocated timer with the specified time interval.
(id)	- initWithFireDate:interval:target:selector:object:object:repeats:
	Initializes an already allocated timer with the specified time interval.
(void)	- fire
	Fires the timer, meaning it will execute the specified selector on the target.
(OFDate *)	- fireDate
	Returns the next date at which the timer will fire.
(void)	- invalidate
	Invalidates the timer, preventing it from firing.
(BOOL)	- isValid
	Returns whether the timer is valid.
(double)	- timeInterval
	Returns the time interval in which the timer will repeat, if it is a repeating timer.
(void)	- waitUntilDone
	Waits until the timer fired.
Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object.
(OFString *)	- className
	Returns the name of the object's class.
(OFString *)	- description
	Returns a description for the object.
(void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool.
(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool.
(void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size.
(void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size.
(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool.
(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: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)	- 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)	- 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.
(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver.
Instance Methods inherited from <OFObject>
(BOOL)	- isKindOfClass:
	Returns a boolean whether the object 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.
(IMP)	- methodForSelector:
	Returns the implementation for the specified selector.
(const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector.
(id)	- performSelector:
	Performs the specified selector.
(id)	- performSelector:withObject:
	Performs the specified selector with the specified object.
(id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.
(BOOL)	- isEqual:
	Checks two objects for equality.
(uint32_t)	- hash
	Calculates a hash for the object.
(id)	- retain
	Increases the retain count.
(unsigned int)	- retainCount
	Returns the retain count.
(void)	- release
	Decreases the retain count.
(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack.
(id)	- self
	Returns the receiver.
(BOOL)	- isProxy
	Returns whether the object is a proxy object.
Instance Methods inherited from <OFComparing>
(of_comparison_result_t)	- compare:
	Compares the object with 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)	+ 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.
Class Methods inherited from OFObject
(void)	+ load
	A method which is called once when the class is loaded into the runtime.
(void)	+ initialize
	A method which is called the moment before the first call to the class is being made.
(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.
(id)	+ new
	Allocates memory for a new instance and calls init on it.
(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.
(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.
(IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.
(const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector.
(OFString *)	+ description
	Returns a description for the class, which is usually the class name.
(IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.
(IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.
(IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method.
(IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method.
(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.

Detailed Description

A class for creating and firing timers.

Method Documentation

- (OFDate*) fireDate

Returns the next date at which the timer will fire.

Returns

The next date at which the timer will fire

- (id) initWithFireDate:		(OFDate*)	fireDate
interval:		(double)	interval
target:		(id)	target
selector:		(SEL)	selector
object:		(id)	object1
object:		(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

- (id) initWithFireDate:		(OFDate*)	fireDate
interval:		(double)	interval
target:		(id)	target
selector:		(SEL)	selector
object:		(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

- (id) initWithFireDate:		(OFDate*)	fireDate
interval:		(double)	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

- (BOOL) isValid

Returns whether the timer is valid.

Returns

Whether the timer is valid

+ (instancetype) scheduledTimerWithTimeInterval:		(double)	interval
target:		(id)	target
selector:		(SEL)	selector
object:		(id)	object1
object:		(id)	object2
repeats:		(BOOL)	repeats

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

Parameters

interval	The time interval after which the timer should be executed when 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

+ (instancetype) scheduledTimerWithTimeInterval:		(double)	interval
target:		(id)	target
selector:		(SEL)	selector
object:		(id)	object
repeats:		(BOOL)	repeats

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

Parameters

interval	The time interval after which the timer should be executed when 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

+ (instancetype) scheduledTimerWithTimeInterval:		(double)	interval
target:		(id)	target
selector:		(SEL)	selector
repeats:		(BOOL)	repeats

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

Parameters

interval	The time interval after which the timer should be executed when 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

- (double) timeInterval

Returns the time interval in which the timer will repeat, if it is a repeating timer.

Returns

The time interval in which the timer will repeat, if it is a repeating timer

+ (instancetype) timerWithTimeInterval:		(double)	interval
target:		(id)	target
selector:		(SEL)	selector
object:		(id)	object1
object:		(id)	object2
repeats:		(BOOL)	repeats

Creates a new timer with the specified time interval.

Parameters

interval	The time interval after which the timer should be executed when 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

+ (instancetype) timerWithTimeInterval:		(double)	interval
target:		(id)	target
selector:		(SEL)	selector
object:		(id)	object
repeats:		(BOOL)	repeats

Creates a new timer with the specified time interval.

Parameters

interval	The time interval after which the timer should be executed when 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

+ (instancetype) timerWithTimeInterval:		(double)	interval
target:		(id)	target
selector:		(SEL)	selector
repeats:		(BOOL)	repeats

Creates a new timer with the specified time interval.

Parameters

interval	The time interval after which the timer should be executed when 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

---

The documentation for this class was generated from the following files:

• src/OFTimer.h
• src/OFTimer.m