OFStream.h File Reference

#include <stdarg.h>
import "OFObject.h"
import "OFString.h"
import "OFRunLoop.h"
import "OFKernelEventObserver.h"

Go to the source code of this file.

Classes
protocol	<OFStreamDelegate>
class	OFStream
	A base class for different types of streams. More...

Typedefs
typedef bool(^)	OFStreamAsyncReadBlock(size_t length, id exception)
	A block which is called when data was read asynchronously from a stream.
typedef bool(^)	OFStreamReadHandler(OFStream *stream, void *buffer, size_t length, id exception)
	A handler which is called when data was read asynchronously from a stream.
typedef bool(^)	OFStreamStringReadHandler(OFStream *stream, OFString *string, id exception)
	A block which is called when a string was read asynchronously from a stream.
typedef bool(^)	OFStreamAsyncReadLineBlock(OFString *line, id exception)
	A block which is called when a line was read asynchronously from a stream.
typedef OFData *(^)	OFStreamAsyncWriteDataBlock(size_t bytesWritten, id exception)
	A block which is called when data was written asynchronously to a stream.
typedef OFData *(^)	OFStreamDataWrittenHandler(OFStream *stream, OFData *data, size_t bytesWritten, id exception)
	A handler which is called when data was written asynchronously to a stream.
typedef OFString *(^)	OFStreamAsyncWriteStringBlock(size_t bytesWritten, id exception)
	A block which is called when a string was written asynchronously to a stream.
typedef OFString *(^)	OFStreamStringWrittenHandler(OFStream *stream, OFString *string, OFStringEncoding encoding, size_t bytesWritten, id exception)
	A handler which is called when a string was written asynchronously to a stream.

Typedef Documentation

OFStreamAsyncReadBlock

typedef bool(^) OFStreamAsyncReadBlock(size_t length, id exception)

A block which is called when data was read asynchronously from a stream.

Deprecated

Use OFStreamReadHandler instead.

Parameters

length	The length of the data that has been read
exception	An exception which occurred while reading or nil on success

Returns

A bool whether the same block should be used for the next read

OFStreamAsyncReadLineBlock

typedef bool(^) OFStreamAsyncReadLineBlock(OFString *line, id exception)

A block which is called when a line was read asynchronously from a stream.

Deprecated

Use OFStreamStringReadHandler instead.

Parameters

line	The line which has been read or nil when the end of stream occurred
exception	An exception which occurred while reading or nil on success

Returns

A bool whether the same block should be used for the next read

OFStreamAsyncWriteDataBlock

typedef OFData *(^) OFStreamAsyncWriteDataBlock(size_t bytesWritten, id exception)

A block which is called when data was written asynchronously to a stream.

Deprecated

Use OFStreamDataWrittenHandler instead.

Parameters

bytesWritten	The number of bytes which have been written. This matches the length of the specified data on the asynchronous write if no exception was encountered.
exception	An exception which occurred while writing or nil on success

Returns

The data to repeat the write with or nil if it should not repeat

OFStreamAsyncWriteStringBlock

typedef OFString *(^) OFStreamAsyncWriteStringBlock(size_t bytesWritten, id exception)

A block which is called when a string was written asynchronously to a stream.

Deprecated

Use OFStreamStringWrittenHandler instead.

Parameters

bytesWritten	The number of bytes which have been written. This matches the length of the specified data on the asynchronous write if no exception was encountered.
exception	An exception which occurred while writing or nil on success

Returns

The string to repeat the write with or nil if it should not repeat

OFStreamDataWrittenHandler

typedef OFData *(^) OFStreamDataWrittenHandler(OFStream *stream, OFData *data, size_t bytesWritten, id exception)

A handler which is called when data was written asynchronously to a stream.

Parameters

stream	The stream to which data was written
data	The data which was written to the stream
bytesWritten	The number of bytes which have been written. This matches the length of the specified data on the asynchronous write if no exception was encountered.
exception	An exception which occurred while writing or nil on success

Returns

The data to repeat the write with or nil if it should not repeat

OFStreamReadHandler

typedef bool(^) OFStreamReadHandler(OFStream *stream, void *buffer, size_t length, id exception)

A handler which is called when data was read asynchronously from a stream.

Parameters

stream	The stream on which data was read
buffer	A buffer with the data that has been read
length	The length of the data that has been read
exception	An exception which occurred while reading or nil on success

Returns

A bool whether the same handler should be used for the next read

OFStreamStringReadHandler

typedef bool(^) OFStreamStringReadHandler(OFStream *stream, OFString *string, id exception)

A block which is called when a string was read asynchronously from a stream.

Parameters

stream	The stream on which a string was read
string	The string which has been read or nil when the end of stream occurred
exception	An exception which occurred while reading or nil on success

Returns

A bool whether the same block should be used for the next read

OFStreamStringWrittenHandler

typedef OFString *(^) OFStreamStringWrittenHandler(OFStream *stream, OFString *string, OFStringEncoding encoding, size_t bytesWritten, id exception)

A handler which is called when a string was written asynchronously to a stream.

Parameters

stream	The stream to which a string was written
string	The string which was written to the stream
encoding	The encoding in which the string was written
bytesWritten	The number of bytes which have been written. This matches the length of the specified data on the asynchronous write if no exception was encountered.
exception	An exception which occurred while writing or nil on success

Returns

The string to repeat the write with or nil if it should not repeat