OFKernelEventObserver Class Reference

A class that can observe multiple kernel events (e.g. streams being ready to read) at once. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFKernelEventObserver:

Instance Methods
(void)	- addObjectForReading:
	Adds an object to observe for reading.
(void)	- addObjectForWriting:
	Adds an object to observe for writing.
(void)	- removeObjectForReading:
	Removes an object to observe for reading.
(void)	- removeObjectForWriting:
	Removes an object to observe for writing.
(void)	- observe
	Observes all objects and blocks until an event happens on an object.
(void)	- observeForTimeInterval:
	Observes all objects until an event happens on an object or the timeout is reached.
(void)	- observeUntilDate:
	Observes all objects until an event happens on an object or the specified date is reached.
(void)	- cancel
	Cancels the currently blocking observe call.
(bool)	- of_processReadBuffers
	This method should be called by subclasses in observeUntilDate: as the first thing to handle all sockets that currently have data in the read buffer.
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
(instancetype)	+ observer
	Creates a new OFKernelEventObserver.
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
id< OFKernelEventObserverDelegate >	delegate
	The delegate for the OFKernelEventObserver.
ULONG	execSignalMask
	A mask of Exec Signals to wait for.
Properties inherited from OFObject
OFString *	className
	The name of the object's class.
OFString *	description
	A description for the object.

Detailed Description

A class that can observe multiple kernel events (e.g. streams being ready to read) at once.

Note

Currently, Win32 can only observe TCP and UDP sockets!

Method Documentation

addObjectForReading:

- (void) addObjectForReading:

(id <OFReadyForReadingObserving>)

object

Adds an object to observe for reading.

This is also used to observe a listening socket for incoming connections, which then triggers a read event for the observed object.

If there is an observe call blocking, it will be canceled. The reason for this is to prevent blocking even though the newly added object is ready.

Parameters

object

The object to observe for reading

Exceptions

OFObserveKernelEventsFailedException

Adding the object for observing failed

addObjectForWriting:

- (void) addObjectForWriting:

(id <OFReadyForWritingObserving>)

object

Adds an object to observe for writing.

If there is an observe call blocking, it will be canceled. The reason for this is to prevent blocking even though the newly added object is ready.

Parameters

object

The object to observe for writing

Exceptions

OFObserveKernelEventsFailedException

Adding the object for observing failed

cancel

- (void) cancel

Cancels the currently blocking observe call.

This is the only method that can and should be called from another thread than the one using the observer.

observe

- (void) observe

Observes all objects and blocks until an event happens on an object.

Exceptions

OFObserveKernelEventsFailedException

Observing for kernel events failed

observeForTimeInterval:

- (void) observeForTimeInterval:

(OFTimeInterval)

timeInterval

Observes all objects until an event happens on an object or the timeout is reached.

Parameters

timeInterval

The time to wait for an event, in seconds

Exceptions

OFObserveKernelEventsFailedException

Observing for kernel events failed

observer

+ (instancetype) observer

Creates a new OFKernelEventObserver.

Returns

A new, autoreleased OFKernelEventObserver

observeUntilDate:

- (void) observeUntilDate:

(OFDate *)

date

Observes all objects until an event happens on an object or the specified date is reached.

Parameters

date	The until which to observe

Exceptions

OFObserveKernelEventsFailedException

Observing for kernel events failed

removeObjectForReading:

- (void) removeObjectForReading:

(id <OFReadyForReadingObserving>)

object

Removes an object to observe for reading.

If there is an observe call blocking, it will be canceled. The reason for this is to prevent the removed object from still being observed.

Parameters

object

The object to remove from observing for reading

Exceptions

OFObserveKernelEventsFailedException

Removing the object for observing failed

removeObjectForWriting:

- (void) removeObjectForWriting:

(id <OFReadyForWritingObserving>)

object

Removes an object to observe for writing.

If there is an observe call blocking, it will be canceled. The reason for this is to prevent the removed object from still being observed.

Parameters

object

The object to remove from observing for writing

Exceptions

OFObserveKernelEventsFailedException

Removing the object for observing failed

Property Documentation

execSignalMask

- (ULONG) execSignalMask

readwritenonatomicassign

A mask of Exec Signals to wait for.

Note

This is only available on AmigaOS!

---

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

• src/OFKernelEventObserver.h
• src/OFKernelEventObserver.m