OFRunLoop Class Reference

A class providing a run loop for the application and its processes. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFRunLoop:

Instance Methods
(void)	- addTimer:
	Adds an OFTimer to the run loop.
(void)	- addTimer:forMode:
	Adds an OFTimer to the run loop for the specified mode.
(void)	- addExecSignal:target:selector:
	Adds an Exec Signal to the run loop.
(void)	- addExecSignal:forMode:target:selector:
	Adds an Exec Signal to the run loop for the specified mode.
(void)	- removeExecSignal:target:selector:
	Removes the specified Exec Signal with the specified target and selector.
(void)	- removeExecSignal:forMode:target:selector:
	Removes the specified Exec Signal from the specified mode with the specified target and selector.
(void)	- run
	Starts the run loop.
(void)	- runUntilDate:
	Run the run loop until the specified deadline.
(void)	- runMode:beforeDate:
	Run the run loop until an event or timer occurs or the specified deadline is reached.
(void)	- stop
	Stops the run loop. If there is still an operation being executed, it is finished before the run loop stops.
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.

Class Methods
(nullable OFRunLoop *)	+ mainRunLoop
	Returns the run loop for the main thread.
(nullable OFRunLoop *)	+ currentRunLoop
	Returns the run loop for the current thread.
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.

Additional Inherited Members
Properties inherited from OFObject
OFString *	className
	The name of the object's class.
OFString *	description
	A description for the object.

Detailed Description

A class providing a run loop for the application and its processes.

Method Documentation

addExecSignal:forMode:target:selector:

- (void) addExecSignal:		(ULONG)	signal
forMode:		(OFRunLoopMode)	mode
target:		(id)	target
selector:		(SEL)	selector

Adds an Exec Signal to the run loop for the specified mode.

If a signal is added multiple times, the specified methods will be performed in the order added.

Note

This is only available on AmigaOS!

Parameters

signal	The signal to add
mode	The run loop mode in which to handle the signal
target	The target to call when the signal was received
selector	The selector to call on the target when the signal was received. The selector must have one parameter for the ULONG of the signal that was received.

addExecSignal:target:selector:

- (void) addExecSignal:		(ULONG)	signal
target:		(id)	target
selector:		(SEL)	selector

Adds an Exec Signal to the run loop.

If a signal is added multiple times, the specified methods will be performed in the order added.

Note

This is only available on AmigaOS!

Parameters

signal	The signal to add
target	The target to call when the signal was received
selector	The selector to call on the target when the signal was received. The selector must have one parameter for the ULONG of the signal that was received.

addTimer:

- (void) addTimer:

(OFTimer *)

timer

Adds an OFTimer to the run loop.

Parameters

timer

The timer to add

addTimer:forMode:

- (void) addTimer:		(OFTimer *)	timer
forMode:		(OFRunLoopMode)	mode

Adds an OFTimer to the run loop for the specified mode.

Parameters

timer	The timer to add
mode	The run loop mode in which to run the timer

currentRunLoop

+ (OFRunLoop *) currentRunLoop

Returns the run loop for the current thread.

Returns

The run loop for the current thread

mainRunLoop

+ (OFRunLoop *) mainRunLoop

Returns the run loop for the main thread.

Returns

The run loop for the main thread

removeExecSignal:forMode:target:selector:

- (void) removeExecSignal:		(ULONG)	signal
forMode:		(OFRunLoopMode)	mode
target:		(id)	target
selector:		(SEL)	selector

Removes the specified Exec Signal from the specified mode with the specified target and selector.

Parameters

signal	The signal to remove
mode	The run loop mode to which the signal was added
target	The target which was specified when adding the signal
selector	The selector which was specified when adding the signal

removeExecSignal:target:selector:

- (void) removeExecSignal:		(ULONG)	signal
target:		(id)	target
selector:		(SEL)	selector

Removes the specified Exec Signal with the specified target and selector.

Parameters

signal	The signal to remove
target	The target which was specified when adding the signal
selector	The selector which was specified when adding the signal

runMode:beforeDate:

- (void) runMode:		(OFRunLoopMode)	mode
beforeDate:		(nullable OFDate *)	deadline

Run the run loop until an event or timer occurs or the specified deadline is reached.

Parameters

mode	The mode in which to run the run loop
deadline	The date until which the run loop should run at the longest

runUntilDate:

- (void) runUntilDate:

(nullable OFDate *)

deadline

Run the run loop until the specified deadline.

Parameters

deadline

The date until which the run loop should run

---

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

• src/OFRunLoop.h
• src/OFRunLoop.m