OFThread Class Reference

A class which provides portable threads. More...

#import <OFThread.h>

Inheritance diagram for OFThread:

Instance Methods
(id)	- initWithObject:
	Initializes an already allocated thread with the specified object.
(id)	- main
	The main routine of the thread. You need to reimplement this!
(void)	- handleTermination
	This routine is exectued when the thread's main method has finished executing or terminate has been called.
(void)	- start
	Starts the thread.
(id)	- join
	Joins a thread.
(OFRunLoop *)	- runLoop
	Returns the run loop for the thread.
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 <OFCopying>
(id)	- copy
	Copies the object.

Class Methods
(instancetype)	+ thread
	Creates a new thread.
(instancetype)	+ threadWithObject:
	Creates a new thread with the specified object.
(void)	+ setObject:forTLSKey:
	Sets the Thread Local Storage for the specified key.
(id)	+ objectForTLSKey:
	Returns the object for the specified Thread Local Storage key.
(OFThread *)	+ currentThread
	Returns the current thread.
(OFThread *)	+ mainThread
	Returns the main thread.
(void)	+ sleepForTimeInterval:
	Suspends execution of the current thread for the specified time interval.
(void)	+ sleepUntilDate:
	Suspends execution of the current thread until the specified date.
(void)	+ yield
	Yields a processor voluntarily and moves the thread at the end of the queue for its priority.
(void)	+ terminate
	Terminates the current thread, letting it return nil.
(void)	+ terminateWithObject:
	Terminates the current thread, letting it return the specified object.
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.

Additional Inherited Members
Public Attributes inherited from OFObject
Class	isa
	The class of the object.

Detailed Description

A class which provides portable threads.

To use it, you should create a new class derived from it and reimplement main.

Warning

Even though the OFCopying protocol is implemented, it does not return an independent copy of the thread, but instead retains it. This is so that the thread can be used as a key for a dictionary, so context can be associated with a thread.

Method Documentation

+ (OFThread *) currentThread

Returns the current thread.

Returns

The current thread

- (void) handleTermination

This routine is exectued when the thread's main method has finished executing or terminate has been called.

Note

Be sure to call [super handleTermination]!

- (id) initWithObject:

(id)

object

Initializes an already allocated thread with the specified object.

Parameters

object

An object which is passed for use in the main method or nil

Returns

An initialized OFThread.

- (id) join

Joins a thread.

Returns

The object returned by the main method of the thread.

- (id) main

The main routine of the thread. You need to reimplement this!

It can access the object passed to the threadWithObject or initWithObject method using the instance variable named object.

Returns

The object the join method should return when called for this thread

+ (OFThread *) mainThread

Returns the main thread.

Returns

The main thread

+ (id) objectForTLSKey:

(OFTLSKey*)

key

Returns the object for the specified Thread Local Storage key.

The returned object is not retained and autoreleased for performance reasons!

Parameters

key	The Thread Local Storage key

- (OFRunLoop *) runLoop

Returns the run loop for the thread.

Returns

The run loop for the thread

+ (void) setObject:		(id)	object
forTLSKey:		(OFTLSKey*)	key

Sets the Thread Local Storage for the specified key.

The specified object is first retained and then the object stored before is released. You can specify nil as object if you want the old object to be released and don't want any new object for the TLS key.

Parameters

key	The Thread Local Storage key
object	The object the Thread Local Storage key will be set to

+ (void) sleepForTimeInterval:

(double)

seconds

Suspends execution of the current thread for the specified time interval.

Parameters

seconds

The number of seconds to sleep

+ (void) sleepUntilDate:

(OFDate*)

date

Suspends execution of the current thread until the specified date.

Parameters

date	The date to wait for

+ (void) terminateWithObject:

(id)

object

Terminates the current thread, letting it return the specified object.

Parameters

object

The object which the terminated thread will return

+ (instancetype) thread

Creates a new thread.

Returns

A new, autoreleased thread

+ (instancetype) threadWithObject:

(id)

object

Creates a new thread with the specified object.

Parameters

object

An object which is passed for use in the main method or nil

Returns

A new, autoreleased thread

---

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

• src/OFThread.h
• src/OFThread.m