Public Member Functions | Static Public Member Functions | Protected Attributes

OFStreamObserver Class Reference

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

#import <OFStreamObserver.h>

Inheritance diagram for OFStreamObserver:
OFObject

List of all members.

Public Member Functions

(id< OFStreamObserverDelegate >) - delegate
(void) - setDelegate:
(void) - addStreamToObserveForReading:
(void) - addStreamToObserveForWriting:
(void) - removeStreamToObserveForReading:
(void) - removeStreamToObserveForWriting:
(void) - observe
(BOOL) - observeWithTimeout:

Static Public Member Functions

(id) + observer

Protected Attributes

OFMutableArray * readStreams
OFMutableArray * writeStreams
id< OFStreamObserverDelegate > delegate
fd_set readfds
fd_set writefds
fd_set exceptfds
int nfds

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) addStreamToObserveForReading: (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 it set to non-blocking mode.

Parameters:
stream The stream to observe for reading
- (void) addStreamToObserveForWriting: (OFStream*)  stream  

Adds a stream to observe for writing.

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

Parameters:
stream The stream to observe for writing
- (id <OFStreamObserverDelegate>) delegate  
Returns:
The delegate for the OFStreamObserver
- (void) observe  

Observes all streams and blocks until an event happens on a stream.

+ (id) observer  
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) removeStreamToObserveForReading: (OFStream*)  stream  

Removes a stream to observe for reading.

Parameters:
stream The stream to remove from observing for reading
- (void) removeStreamToObserveForWriting: (OFStream*)  stream  

Removes a stream to observe for writing.

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:
 All Classes Functions Variables
Generated on Mon Jan 3 2011 23:03:10 for ObjFW by  doxygen 1.7.1