OFStreamObserver Class Reference

A class that can observe multiple streams at once. More...

#import <OFStreamObserver.h>

Inheritance diagram for OFStreamObserver:

List of all members.

Public Member Functions
(id< OFStreamObserverDelegate >)	- delegate
	Returns the delegate for the OFStreamObserver.
(void)	- setDelegate:
	Sets the delegate for the OFStreamObserver.
(void)	- addStreamForReading:
	Adds a stream to observe for reading.
(void)	- addStreamForWriting:
	Adds a stream to observe for writing.
(void)	- removeStreamForReading:
	Removes a stream to observe for reading.
(void)	- removeStreamForWriting:
	Removes a stream to observe for writing.
(void)	- observe
	Observes all streams and blocks until an event happens on a stream.
(BOOL)	- observeWithTimeout:
	Observes all streams until an event happens on a stream or the timeout is reached.
Static Public Member Functions
(id)	+ observer
	Creates a new OFStreamObserver.

---

Detailed Description

A class that can observe multiple streams at once.

Note: Currently, Win32 can only observe sockets and not files!

---

Member Function Documentation

- (void) addStreamForReading:

(OFStream*)

stream

Adds a stream 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 stream.

It is recommended that the stream you add is set to non-blocking mode.

If there is an -[observe] call blocking, it will be canceled. The reason for this is to prevent blocking even though the new added stream is ready.

Parameters:

stream

The stream to observe for reading

- (void) addStreamForWriting:

(OFStream*)

stream

Adds a stream to observe for writing.

It is recommended that the stream you add is set to non-blocking mode.

If there is an -[observe] call blocking, it will be canceled. The reason for this is to prevent blocking even though the new added stream is ready.

Parameters:

stream

The stream to observe for writing

- (id <OFStreamObserverDelegate>) delegate

Returns the delegate for the OFStreamObserver.

Returns:

The delegate for the OFStreamObserver

+ (id) observer

Creates a new OFStreamObserver.

Returns:

A new, autoreleased OFStreamObserver

- (BOOL) observeWithTimeout:

(int)

timeout

Observes all streams until an event happens on a stream or the timeout is reached.

Parameters:

timeout

The time to wait for an event, in milliseconds

Returns:

A boolean whether events occurred during the timeinterval

- (void) removeStreamForReading:

(OFStream*)

stream

Removes a stream to observe for reading.

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

Parameters:

stream

The stream to remove from observing for reading

- (void) removeStreamForWriting:

(OFStream*)

stream

Removes a stream to observe for writing.

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

Parameters:

stream

The stream to remove from observing for writing

- (void) setDelegate:

(id <OFStreamObserverDelegate>)

delegate

Sets the delegate for the OFStreamObserver.

Parameters:

delegate

The delegate for the OFStreamObserver

---

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

• src/OFStreamObserver.h
• src/OFStreamObserver.m