A base class for different types of streams. More...

#include <ObjFW/ObjFW.h>

Inheritance diagram for OFStream:

Instance Methods
(size_t)	- readIntoBuffer:length:
	Reads at most `length` bytes from the stream into a buffer.

(void)	- readIntoBuffer:exactLength:
	Reads exactly the specified `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:length:
	Asynchronously reads at most `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:length:runLoopMode:
	Asynchronously reads at most `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:exactLength:
	Asynchronously reads exactly the specified `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:exactLength:runLoopMode:
	Asynchronously reads exactly the specified `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:length:block:
	Asynchronously reads at most ref `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:length:handler:
	Asynchronously reads at most ref `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:length:runLoopMode:block:
	Asynchronously reads at most `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:length:runLoopMode:handler:
	Asynchronously reads at most `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:exactLength:block:
	Asynchronously reads exactly the specified `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:exactLength:handler:
	Asynchronously reads exactly the specified `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:exactLength:runLoopMode:block:
	Asynchronously reads exactly the specified `length` bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:exactLength:runLoopMode:handler:
	Asynchronously reads exactly the specified `length` bytes from the stream into a buffer.

(uint8_t)	- readInt8
	Reads a uint8_t from the stream.

(uint16_t)	- readBigEndianInt16
	Reads a uint16_t from the stream which is encoded in big endian.

(uint32_t)	- readBigEndianInt32
	Reads a uint32_t from the stream which is encoded in big endian.

(uint64_t)	- readBigEndianInt64
	Reads a uint64_t from the stream which is encoded in big endian.

(float)	- readBigEndianFloat
	Reads a float from the stream which is encoded in big endian.

(double)	- readBigEndianDouble
	Reads a double from the stream which is encoded in big endian.

(uint16_t)	- readLittleEndianInt16
	Reads a uint16_t from the stream which is encoded in little endian.

(uint32_t)	- readLittleEndianInt32
	Reads a uint32_t from the stream which is encoded in little endian.

(uint64_t)	- readLittleEndianInt64
	Reads a uint64_t from the stream which is encoded in little endian.

(float)	- readLittleEndianFloat
	Reads a float from the stream which is encoded in little endian.

(double)	- readLittleEndianDouble
	Reads a double from the stream which is encoded in little endian.

(OFData *)	- readDataWithCount:
	Reads the specified number of items with an item size of 1 from the stream and returns them as OFData.

(OFData *)	- readDataWithItemSize:count:
	Reads the specified number of items with the specified item size from the stream and returns them as OFData.

(OFData *)	- readDataUntilEndOfStream
	Returns OFData with all the remaining data of the stream.

(OFString *)	- readString
	Reads a string until a `\0` appears in the stream or the end of the stream is reached.

(OFString *)	- readStringWithEncoding:
	Reads a string with the specified encoding until a `\0` appears in the stream or the end of the stream is reached.

(OFString *)	- readStringWithLength:
	Reads a string with the specified length from the stream.

(OFString *)	- readStringWithLength:encoding:
	Reads a string with the specified encoding and length from the stream.

(nullable OFString *)	- readLine
	Reads until a newline, `\0` or end of stream occurs.

(nullable OFString *)	- readLineWithEncoding:
	Reads with the specified encoding until a newline, `\0` or end of stream occurs.

(void)	- asyncReadString
	Asynchronously reads until a `\0`, end of stream or an exception occurs.

(void)	- asyncReadStringWithEncoding:
	Asynchronously reads with the specified encoding until a `\0`, end of stream or an exception occurs.

(void)	- asyncReadStringWithEncoding:runLoopMode:
	Asynchronously reads with the specified encoding until a `\0`, end of stream or an exception occurs.

(void)	- asyncReadLine
	Asynchronously reads until a newline, `\0`, end of stream or an exception occurs.

(void)	- asyncReadLineWithEncoding:
	Asynchronously reads with the specified encoding until a newline, `\0`, end of stream or an exception occurs.

(void)	- asyncReadLineWithEncoding:runLoopMode:
	Asynchronously reads with the specified encoding until a newline, `\0`, end of stream or an exception occurs.

(void)	- asyncReadStringWithHandler:
	Asynchronously reads until a `\0`, end of stream or an exception occurs.

(void)	- asyncReadStringWithEncoding:handler:
	Asynchronously reads with the specified encoding until a `\0`, end of stream or an exception occurs.

(void)	- asyncReadStringWithEncoding:runLoopMode:handler:
	Asynchronously reads with the specified encoding until a `\0`, end of stream or an exception occurs.

(void)	- asyncReadLineWithBlock:
	Asynchronously reads until a newline, `\0`, end of stream or an exception occurs.

(void)	- asyncReadLineWithHandler:
	Asynchronously reads until a newline, `\0`, end of stream or an exception occurs.

(void)	- asyncReadLineWithEncoding:block:
	Asynchronously reads with the specified encoding until a newline, `\0`, end of stream or an exception occurs.

(void)	- asyncReadLineWithEncoding:handler:
	Asynchronously reads with the specified encoding until a newline, `\0`, end of stream or an exception occurs.

(void)	- asyncReadLineWithEncoding:runLoopMode:block:
	Asynchronously reads with the specified encoding until a newline, `\0`, end of stream or an exception occurs.

(void)	- asyncReadLineWithEncoding:runLoopMode:handler:
	Asynchronously reads with the specified encoding until a newline, `\0`, end of stream or an exception occurs.

(OFString *)	- tryReadString
	Tries to read a string until a `\0` appears in the stream or the end of the stream is reached.

(OFString *)	- tryReadStringWithEncoding:
	Tries to read a string with the specified encoding until a `\0` appears in the stream or the end of the stream is reached.

(nullable OFString *)	- tryReadLine
	Tries to read a line from the stream (see readLine) and returns `nil` if no complete line has been received yet.

(nullable OFString *)	- tryReadLineWithEncoding:
	Tries to read a line from the stream with the specified encoding (see readLineWithEncoding:) and returns `nil` if no complete line has been received yet.

(nullable OFString *)	- readUntilDelimiter:
	Reads until the specified string or `\0` is found or the end of stream occurs.

(nullable OFString *)	- readUntilDelimiter:encoding:
	Reads until the specified string or `\0` is found or the end of stream occurs.

(nullable OFString *)	- tryReadUntilDelimiter:
	Tries to reads until the specified string or `\0` is found or the end of stream (see readUntilDelimiter:) and returns `nil` if not enough data has been received yet.

(nullable OFString *)	- tryReadUntilDelimiter:encoding:
	Tries to read until the specified string or `\0` is found or the end of stream occurs (see readUntilDelimiter:encoding:) and returns `nil` if not enough data has been received yet.

(bool)	- flushWriteBuffer
	Writes everything in the write buffer to the stream.

(void)	- writeBuffer:length:
	Writes from a buffer into the stream.

(void)	- asyncWriteData:
	Asynchronously writes data into the stream.

(void)	- asyncWriteData:runLoopMode:
	Asynchronously writes data into the stream.

(void)	- asyncWriteString:
	Asynchronously writes a string in UTF-8 encoding into the stream.

(void)	- asyncWriteString:encoding:
	Asynchronously writes a string in the specified encoding into the stream.

(void)	- asyncWriteString:encoding:runLoopMode:
	Asynchronously writes a string in the specified encoding into the stream.

(void)	- asyncWriteData:block:
	Asynchronously writes data into the stream.

(void)	- asyncWriteData:handler:
	Asynchronously writes data into the stream.

(void)	- asyncWriteData:runLoopMode:block:
	Asynchronously writes data into the stream.

(void)	- asyncWriteData:runLoopMode:handler:
	Asynchronously writes data into the stream.

(void)	- asyncWriteString:block:
	Asynchronously writes a string into the stream.

(void)	- asyncWriteString:handler:
	Asynchronously writes a string into the stream.

(void)	- asyncWriteString:encoding:block:
	Asynchronously writes a string in the specified encoding into the stream.

(void)	- asyncWriteString:encoding:handler:
	Asynchronously writes a string in the specified encoding into the stream.

(void)	- asyncWriteString:encoding:runLoopMode:block:
	Asynchronously writes a string in the specified encoding into the stream.

(void)	- asyncWriteString:encoding:runLoopMode:handler:
	Asynchronously writes a string in the specified encoding into the stream.

(void)	- writeInt8:
	Writes a uint8_t into the stream.

(void)	- writeBigEndianInt16:
	Writes a uint16_t into the stream, encoded in big endian.

(void)	- writeBigEndianInt32:
	Writes a uint32_t into the stream, encoded in big endian.

(void)	- writeBigEndianInt64:
	Writes a uint64_t into the stream, encoded in big endian.

(void)	- writeBigEndianFloat:
	Writes a float into the stream, encoded in big endian.

(void)	- writeBigEndianDouble:
	Writes a double into the stream, encoded in big endian.

(void)	- writeLittleEndianInt16:
	Writes a uint16_t into the stream, encoded in little endian.

(void)	- writeLittleEndianInt32:
	Writes a uint32_t into the stream, encoded in little endian.

(void)	- writeLittleEndianInt64:
	Writes a uint64_t into the stream, encoded in little endian.

(void)	- writeLittleEndianFloat:
	Writes a float into the stream, encoded in little endian.

(void)	- writeLittleEndianDouble:
	Writes a double into the stream, encoded in little endian.

(void)	- writeData:
	Writes OFData into the stream.

(void)	- writeString:
	Writes a string into the stream, without the trailing zero.

(void)	- writeString:encoding:
	Writes a string into the stream in the specified encoding, without the trailing zero.

(void)	- writeLine:
	Writes a string into the stream with a trailing newline.

(void)	- writeLine:encoding:
	Writes a string into the stream in the specified encoding with a trailing newline.

(void)	- writeFormat:
	Writes a formatted string into the stream.

(void)	- writeFormat:arguments:
	Writes a formatted string into the stream.

(void)	- cancelAsyncRequests
	Cancels all pending asynchronous requests on the stream.

(void)	- unreadFromBuffer:length:
	"Reverses" a read operation, meaning the bytes from the specified buffer will be returned on the next read operation.

(void)	- close
	Closes the stream.

(size_t)	- lowlevelReadIntoBuffer:length:
	Performs a lowlevel read.

(size_t)	- lowlevelWriteBuffer:length:
	Performs a lowlevel write.

(bool)	- lowlevelIsAtEndOfStream
	Returns whether the lowlevel is at the end of the stream.

(bool)	- lowlevelHasDataInReadBuffer
	Returns whether the lowlevel has 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.

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies the object.

Properties
bool	atEndOfStream
	Whether the end of the stream has been reached.

bool	buffersWrites
	Whether writes are buffered.

bool	hasDataInReadBuffer
	Whether data is present in the internal read buffer.

bool	canBlock
	Whether the stream can block.

id< OFStreamDelegate >	delegate
	The delegate for asynchronous operations on the stream.

Properties inherited from OFObject
OFString *	className
	The name of the object's class.

OFString *	description
	A description for the object.

Additional Inherited Members
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.

Detailed Description

A base class for different types of streams.

Warning: Even though the OFCopying protocol is implemented, it does not return an independent copy of the stream, but instead retains it. This is so that the stream can be used as a key for a dictionary, so context can be associated with a stream. Using a stream in more than one thread at the same time is not thread-safe, even if copy was called to create one "instance" for every thread!

Note: If you want to subclass this, override lowlevelReadIntoBuffer:length: (OFStream), lowlevelWriteBuffer:length: (OFStream) and lowlevelIsAtEndOfStream (OFStream), but nothing else, as those are are the methods that do the actual work. OFStream uses those for all other methods and does all the caching and other stuff for you. If you override these methods without the lowlevel prefix, you will break caching and get broken results!

Method Documentation

◆ asyncReadIntoBuffer:exactLength:

- (void) asyncReadIntoBuffer:		(void *)	buffer
exactLength:		(size_t)	length

Asynchronously reads exactly the specified length bytes from the stream into a buffer.

Unlike asyncReadIntoBuffer:length:, this method does not call the method when less than the specified length has been read - instead, it waits until it got exactly the specified length, the stream has ended or an exception occurred.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read. The buffer must be at least this big!

◆ asyncReadIntoBuffer:exactLength:block:

- (void) asyncReadIntoBuffer:	(void *)	buffer
exactLength:	(size_t)	length
block:	(OFStreamAsyncReadBlock)	block

Asynchronously reads exactly the specified length bytes from the stream into a buffer.

Deprecated: Use asyncReadIntoBuffer:exactLength:handler: instead.

Unlike asyncReadIntoBuffer:length:block:, this method does not invoke the block when less than the specified length has been read - instead, it waits until it got exactly the specified length, the stream has ended or an exception occurred.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read. The buffer must be at least this big!
block	The block to call when the data has been received. If the block returns true, it will be called again with the same buffer and exact length when more data has been received. If you want the next block in the queue to handle the data received next, you need to return false from the block.

◆ asyncReadIntoBuffer:exactLength:handler:

- (void) asyncReadIntoBuffer:	(void *)	buffer
exactLength:	(size_t)	length
handler:	(OFStreamReadHandler)	handler

Asynchronously reads exactly the specified length bytes from the stream into a buffer.

Unlike asyncReadIntoBuffer:length:handler:, this method does not invoke the handler when less than the specified length has been read - instead, it waits until it got exactly the specified length, the stream has ended or an exception occurred.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read. The buffer must be at least this big!
handler	The handler to call when the data has been received. If the handler returns true, it will be called again with the same buffer and exact length when more data has been received. If you want the next handler in the queue to handle the data received next, you need to return false from the handler.

◆ asyncReadIntoBuffer:exactLength:runLoopMode:

- (void) asyncReadIntoBuffer:	(void *)	buffer
exactLength:	(size_t)	length
runLoopMode:	(OFRunLoopMode)	runLoopMode

Asynchronously reads exactly the specified length bytes from the stream into a buffer.

Unlike asyncReadIntoBuffer:length:, this method does not call the method when less than the specified length has been read - instead, it waits until it got exactly the specified length, the stream has ended or an exception occurred.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read. The buffer must be at least this big!
runLoopMode	The run loop mode in which to perform the async read

◆ asyncReadIntoBuffer:exactLength:runLoopMode:block:

- (void) asyncReadIntoBuffer:	(void *)	buffer
exactLength:	(size_t)	length
runLoopMode:	(OFRunLoopMode)	runLoopMode
block:	(OFStreamAsyncReadBlock)	block

Asynchronously reads exactly the specified length bytes from the stream into a buffer.

Deprecated: Use asyncReadIntoBuffer:exactLength:runLoopMode:handler: instead.

Unlike asyncReadIntoBuffer:length:block:, this method does not invoke the block when less than the specified length has been read - instead, it waits until it got exactly the specified length, the stream has ended or an exception occurred.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read. The buffer must be at least this big!
runLoopMode	The run loop mode in which to perform the async read
block	The block to call when the data has been received. If the block returns true, it will be called again with the same buffer and exact length when more data has been received. If you want the next block in the queue to handle the data received next, you need to return false from the block.

◆ asyncReadIntoBuffer:exactLength:runLoopMode:handler:

- (void) asyncReadIntoBuffer:	(void *)	buffer
exactLength:	(size_t)	length
runLoopMode:	(OFRunLoopMode)	runLoopMode
handler:	(OFStreamReadHandler)	handler

Asynchronously reads exactly the specified length bytes from the stream into a buffer.

Unlike asyncReadIntoBuffer:length:handler:, this method does not invoke the handler when less than the specified length has been read - instead, it waits until it got exactly the specified length, the stream has ended or an exception occurred.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read. The buffer must be at least this big!
runLoopMode	The run loop mode in which to perform the async read
handler	The handler to call when the data has been received. If the handler returns true, it will be called again with the same buffer and exact length when more data has been received. If you want the next handler in the queue to handle the data received next, you need to return false from the handler.

◆ asyncReadIntoBuffer:length:

- (void) asyncReadIntoBuffer:		(void *)	buffer
length:		(size_t)	length

Asynchronously reads at most length bytes from the stream into a buffer.

On network streams, this might read less than the specified number of bytes. If you want to read exactly the specified number of bytes, use asyncReadIntoBuffer:exactLength:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read. The buffer must not be freed before the async read completed!
length	The length of the data that should be read at most. The buffer must be at least this big!

◆ asyncReadIntoBuffer:length:block:

- (void) asyncReadIntoBuffer:	(void *)	buffer
length:	(size_t)	length
block:	(OFStreamAsyncReadBlock)	block

Asynchronously reads at most ref length bytes from the stream into a buffer.

Deprecated: Use asyncReadIntoBuffer:length:handler: instead.

On network streams, this might read less than the specified number of bytes. If you want to read exactly the specified number of bytes, use asyncReadIntoBuffer:exactLength:block:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read. The buffer must not be freed before the async read completed!
length	The length of the data that should be read at most. The buffer must be at least this big!
block	The block to call when the data has been received. If the block returns true, it will be called again with the same buffer and maximum length when more data has been received. If you want the next block in the queue to handle the data received next, you need to return false from the block.

◆ asyncReadIntoBuffer:length:handler:

- (void) asyncReadIntoBuffer:	(void *)	buffer
length:	(size_t)	length
handler:	(OFStreamReadHandler)	handler

Asynchronously reads at most ref length bytes from the stream into a buffer.

On network streams, this might read less than the specified number of bytes. If you want to read exactly the specified number of bytes, use asyncReadIntoBuffer:exactLength:handler:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read. The buffer must not be freed before the async read completed!
length	The length of the data that should be read at most. The buffer must be at least this big!
handler	The handler to call when the data has been received. If the handler returns true, it will be called again with the same buffer and maximum length when more data has been received. If you want the next handler in the queue to handle the data received next, you need to return false from the handler.

◆ asyncReadIntoBuffer:length:runLoopMode:

- (void) asyncReadIntoBuffer:	(void *)	buffer
length:	(size_t)	length
runLoopMode:	(OFRunLoopMode)	runLoopMode

Asynchronously reads at most length bytes from the stream into a buffer.

On network streams, this might read less than the specified number of bytes. If you want to read exactly the specified number of bytes, use asyncReadIntoBuffer:exactLength:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read. The buffer must not be freed before the async read completed!
length	The length of the data that should be read at most. The buffer must be at least this big!
runLoopMode	The run loop mode in which to perform the async read

◆ asyncReadIntoBuffer:length:runLoopMode:block:

- (void) asyncReadIntoBuffer:	(void *)	buffer
length:	(size_t)	length
runLoopMode:	(OFRunLoopMode)	runLoopMode
block:	(OFStreamAsyncReadBlock)	block

Asynchronously reads at most length bytes from the stream into a buffer.

Deprecated: Use asyncReadIntoBuffer:length:runLoopMode:handler: instead.

On network streams, this might read less than the specified number of bytes. If you want to read exactly the specified number of bytes, use asyncReadIntoBuffer:exactLength:block:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read. The buffer must not be freed before the async read completed!
length	The length of the data that should be read at most. The buffer must be at least this big!
runLoopMode	The run loop mode in which to perform the async read
block	The block to call when the data has been received. If the block returns true, it will be called again with the same buffer and maximum length when more data has been received. If you want the next block in the queue to handle the data received next, you need to return false from the block.

◆ asyncReadIntoBuffer:length:runLoopMode:handler:

- (void) asyncReadIntoBuffer:	(void *)	buffer
length:	(size_t)	length
runLoopMode:	(OFRunLoopMode)	runLoopMode
handler:	(OFStreamReadHandler)	handler

Asynchronously reads at most length bytes from the stream into a buffer.

On network streams, this might read less than the specified number of bytes. If you want to read exactly the specified number of bytes, use asyncReadIntoBuffer:exactLength:handler:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

buffer	The buffer into which the data is read. The buffer must not be freed before the async read completed!
length	The length of the data that should be read at most. The buffer must be at least this big!
runLoopMode	The run loop mode in which to perform the async read
handler	The handler to call when the data has been received. If the handler returns true, it will be called again with the same buffer and maximum length when more data has been received. If you want the next handler in the queue to handle the data received next, you need to return false from the handler.

◆ asyncReadLine

- (void) asyncReadLine

Asynchronously reads until a newline, \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

◆ asyncReadLineWithBlock:

- (void) asyncReadLineWithBlock: (OFStreamAsyncReadLineBlock) block

Asynchronously reads until a newline, \0, end of stream or an exception occurs.

Deprecated: Use asyncReadLineWithHandler: instead.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

block The block to call when the data has been received. If the block returns true, it will be called again when the next line has been received. If you want the next block in the queue to handle the next line, you need to return false from the block.

◆ asyncReadLineWithEncoding:

- (void) asyncReadLineWithEncoding: (OFStringEncoding) encoding

Asynchronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding The encoding used by the stream

◆ asyncReadLineWithEncoding:block:

- (void) asyncReadLineWithEncoding:		(OFStringEncoding)	encoding
block:		(OFStreamAsyncReadLineBlock)	block

Asynchronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs.

Deprecated: Use asyncReadLineWithEncoding:handler: instead.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding	The encoding used by the stream
block	The block to call when the data has been received. If the block returns true, it will be called again when the next line has been received. If you want the next block in the queue to handle the next line, you need to return false from the block.

◆ asyncReadLineWithEncoding:handler:

- (void) asyncReadLineWithEncoding:		(OFStringEncoding)	encoding
handler:		(OFStreamStringReadHandler)	handler

Asynchronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding	The encoding used by the stream
handler	The handler to call when the data has been received. If the handler returns true, it will be called again when the next line has been received. If you want the next handler in the queue to handle the next line, you need to return false from the handler.

◆ asyncReadLineWithEncoding:runLoopMode:

- (void) asyncReadLineWithEncoding:		(OFStringEncoding)	encoding
runLoopMode:		(OFRunLoopMode)	runLoopMode

Asynchronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding	The encoding used by the stream
runLoopMode	The run loop mode in which to perform the async read

◆ asyncReadLineWithEncoding:runLoopMode:block:

- (void) asyncReadLineWithEncoding:	(OFStringEncoding)	encoding
runLoopMode:	(OFRunLoopMode)	runLoopMode
block:	(OFStreamAsyncReadLineBlock)	block

Asynchronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs.

Deprecated: Use asyncReadLineWithEncoding:runLoopMode:handler: instead.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding	The encoding used by the stream
runLoopMode	The run loop mode in which to perform the async read
block	The block to call when the data has been received. If the block returns true, it will be called again when the next line has been received. If you want the next block in the queue to handle the next line, you need to return false from the block.

◆ asyncReadLineWithEncoding:runLoopMode:handler:

- (void) asyncReadLineWithEncoding:	(OFStringEncoding)	encoding
runLoopMode:	(OFRunLoopMode)	runLoopMode
handler:	(OFStreamStringReadHandler)	handler

Asynchronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding	The encoding used by the stream
runLoopMode	The run loop mode in which to perform the async read
handler	The handler to call when the data has been received. If the handler returns true, it will be called again when the next line has been received. If you want the next handler in the queue to handle the next line, you need to return false from the handler.

◆ asyncReadLineWithHandler:

- (void) asyncReadLineWithHandler: (OFStreamStringReadHandler) handler

Asynchronously reads until a newline, \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

handler The handler to call when the data has been received. If the handler returns true, it will be called again when the next line has been received. If you want the next handler in the queue to handle the next line, you need to return false from the handler.

◆ asyncReadString

- (void) asyncReadString

Asynchronously reads until a \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

◆ asyncReadStringWithEncoding:

- (void) asyncReadStringWithEncoding: (OFStringEncoding) encoding

Asynchronously reads with the specified encoding until a \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding The encoding used by the stream

◆ asyncReadStringWithEncoding:handler:

- (void) asyncReadStringWithEncoding:		(OFStringEncoding)	encoding
handler:		(OFStreamStringReadHandler)	handler

Asynchronously reads with the specified encoding until a \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding	The encoding used by the stream
handler	The handler to call when the data has been received. If the handler returns true, it will be called again when the next string has been received. If you want the next handler in the queue to handle the next string, you need to return false from the handler.

◆ asyncReadStringWithEncoding:runLoopMode:

- (void) asyncReadStringWithEncoding:		(OFStringEncoding)	encoding
runLoopMode:		(OFRunLoopMode)	runLoopMode

Asynchronously reads with the specified encoding until a \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding	The encoding used by the stream
runLoopMode	The run loop mode in which to perform the async read

◆ asyncReadStringWithEncoding:runLoopMode:handler:

- (void) asyncReadStringWithEncoding:	(OFStringEncoding)	encoding
runLoopMode:	(OFRunLoopMode)	runLoopMode
handler:	(OFStreamStringReadHandler)	handler

Asynchronously reads with the specified encoding until a \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

encoding	The encoding used by the stream
runLoopMode	The run loop mode in which to perform the async read
handler	The handler to call when the data has been received. If the handler returns true, it will be called again when the next string has been received. If you want the next handler in the queue to handle the next string, you need to return false from the handler.

◆ asyncReadStringWithHandler:

- (void) asyncReadStringWithHandler: (OFStreamStringReadHandler) handler

Asynchronously reads until a \0, end of stream or an exception occurs.

Note: The stream must conform to OFReadyForReadingObserving in order for this to work!

Parameters

handler The handler to call when the data has been received. If the handler returns true, it will be called again when the next string has been received. If you want the next handler in the queue to handle the next string, you need to return false from the handler.

◆ asyncWriteData:

- (void) asyncWriteData: (OFData *) data

Asynchronously writes data into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

data	The data which is written into the stream

◆ asyncWriteData:block:

- (void) asyncWriteData:		(OFData *)	data
block:		(OFStreamAsyncWriteDataBlock)	block

Asynchronously writes data into the stream.

Deprecated: Use asyncWriteData:handler: instead.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

data	The data which is written into the stream
block	The block to call when the data has been written. It should return the data for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteData:handler:

- (void) asyncWriteData:		(OFData *)	data
handler:		(OFStreamDataWrittenHandler)	handler

Asynchronously writes data into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

data	The data which is written into the stream
handler	The handler to call when the data has been written. It should return the data for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteData:runLoopMode:

- (void) asyncWriteData:		(OFData *)	data
runLoopMode:		(OFRunLoopMode)	runLoopMode

Asynchronously writes data into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

data	The data which is written into the stream
runLoopMode	The run loop mode in which to perform the async write

◆ asyncWriteData:runLoopMode:block:

- (void) asyncWriteData:	(OFData *)	data
runLoopMode:	(OFRunLoopMode)	runLoopMode
block:	(OFStreamAsyncWriteDataBlock)	block

Asynchronously writes data into the stream.

Deprecated: Use asyncWriteData:runLoopMode:handler: instead.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

data	The data which is written into the stream
runLoopMode	The run loop mode in which to perform the async write
block	The block to call when the data has been written. It should return the data for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteData:runLoopMode:handler:

- (void) asyncWriteData:	(OFData *)	data
runLoopMode:	(OFRunLoopMode)	runLoopMode
handler:	(OFStreamDataWrittenHandler)	handler

Asynchronously writes data into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

data	The data which is written into the stream
runLoopMode	The run loop mode in which to perform the async write
handler	The handler to call when the data has been written. It should return the data for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteString:

- (void) asyncWriteString: (OFString *) string

Asynchronously writes a string in UTF-8 encoding into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string The string which is written into the stream

◆ asyncWriteString:block:

- (void) asyncWriteString:		(OFString *)	string
block:		(OFStreamAsyncWriteStringBlock)	block

Asynchronously writes a string into the stream.

Deprecated: Use asyncWriteString:handler: instead.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string	The string which is written into the stream
block	The block to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteString:encoding:

- (void) asyncWriteString:		(OFString *)	string
encoding:		(OFStringEncoding)	encoding

Asynchronously writes a string in the specified encoding into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string	The string which is written into the stream
encoding	The encoding in which the string should be written to the stream

◆ asyncWriteString:encoding:block:

- (void) asyncWriteString:	(OFString *)	string
encoding:	(OFStringEncoding)	encoding
block:	(OFStreamAsyncWriteStringBlock)	block

Asynchronously writes a string in the specified encoding into the stream.

Deprecated: Use asyncWriteString:encoding:handler: instead.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string	The string which is written into the stream
encoding	The encoding in which the string should be written to the stream
block	The block to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteString:encoding:handler:

- (void) asyncWriteString:	(OFString *)	string
encoding:	(OFStringEncoding)	encoding
handler:	(OFStreamStringWrittenHandler)	handler

Asynchronously writes a string in the specified encoding into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string	The string which is written into the stream
encoding	The encoding in which the string should be written to the stream
handler	The handler to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteString:encoding:runLoopMode:

- (void) asyncWriteString:	(OFString *)	string
encoding:	(OFStringEncoding)	encoding
runLoopMode:	(OFRunLoopMode)	runLoopMode

Asynchronously writes a string in the specified encoding into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string	The string which is written into the stream
encoding	The encoding in which the string should be written to the stream
runLoopMode	The run loop mode in which to perform the async write

◆ asyncWriteString:encoding:runLoopMode:block:

- (void) asyncWriteString:	(OFString *)	string
encoding:	(OFStringEncoding)	encoding
runLoopMode:	(OFRunLoopMode)	runLoopMode
block:	(OFStreamAsyncWriteStringBlock)	block

Asynchronously writes a string in the specified encoding into the stream.

Deprecated: Use asyncWriteString:encoding:runLoopMode:handler: instead.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string	The string which is written into the stream
encoding	The encoding in which the string should be written to the stream
runLoopMode	The run loop mode in which to perform the async write
block	The block to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteString:encoding:runLoopMode:handler:

- (void) asyncWriteString:	(OFString *)	string
encoding:	(OFStringEncoding)	encoding
runLoopMode:	(OFRunLoopMode)	runLoopMode
handler:	(OFStreamStringWrittenHandler)	handler

Asynchronously writes a string in the specified encoding into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string	The string which is written into the stream
encoding	The encoding in which the string should be written to the stream
runLoopMode	The run loop mode in which to perform the async write
handler	The handler to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat.

◆ asyncWriteString:handler:

- (void) asyncWriteString:		(OFString *)	string
handler:		(OFStreamStringWrittenHandler)	handler

Asynchronously writes a string into the stream.

Note: The stream must conform to OFReadyForWritingObserving in order for this to work!

Parameters

string	The string which is written into the stream
handler	The handler to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat.

◆ close

- (void) close

Closes the stream.

Note: If you override this, make sure to call [super close]!

Exceptions

OFNotOpenException The stream is not open

◆ flushWriteBuffer

- (bool) flushWriteBuffer

Writes everything in the write buffer to the stream.

Returns: Whether the write buffer was flushed entirely. On non-blocking sockets, this can return false if flushing the write buffer in its entirety would block.

◆ lowlevelHasDataInReadBuffer

- (bool) lowlevelHasDataInReadBuffer

Returns whether the lowlevel has data in the read buffer.

Warning: Do not call this directly!

Note: Override this method in case your stream can buffer data itself, such as when implementing OFTLSStream. If not overridden, it always returns false.

Returns: Whether the lowlevel has data in the read buffer

◆ lowlevelIsAtEndOfStream

- (bool) lowlevelIsAtEndOfStream

Returns whether the lowlevel is at the end of the stream.

Warning: Do not call this directly!

Note: Override this method with your actual end of stream checking implementation when subclassing!

Returns: Whether the lowlevel is at the end of the stream

◆ lowlevelReadIntoBuffer:length:

- (size_t) lowlevelReadIntoBuffer:		(void *)	buffer
length:		(size_t)	length

Performs a lowlevel read.

Warning: Do not call this directly!

Note: Override this method with your actual read implementation when subclassing!

Parameters

buffer	The buffer for the data to read
length	The length of the buffer

Returns: The number of bytes read

Exceptions

OFReadFailedException	Reading failed
OFNotOpenException	The stream is not open

◆ lowlevelWriteBuffer:length:

- (size_t) lowlevelWriteBuffer:		(const void *)	buffer
length:		(size_t)	length

Performs a lowlevel write.

Warning: Do not call this directly!

Note: Override this method with your actual write implementation when subclassing!

Parameters

buffer	The buffer with the data to write
length	The length of the data to write

Returns: The number of bytes written

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ readBigEndianDouble

- (double) readBigEndianDouble

Reads a double from the stream which is encoded in big endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A double from the stream in big endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readBigEndianFloat

- (float) readBigEndianFloat

Reads a float from the stream which is encoded in big endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A float from the stream in big endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readBigEndianInt16

- (uint16_t) readBigEndianInt16

Reads a uint16_t from the stream which is encoded in big endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A uint16_t from the stream in big endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readBigEndianInt32

- (uint32_t) readBigEndianInt32

Reads a uint32_t from the stream which is encoded in big endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A uint32_t from the stream in big endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readBigEndianInt64

- (uint64_t) readBigEndianInt64

Reads a uint64_t from the stream which is encoded in big endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A uint64_t from the stream in big endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readDataUntilEndOfStream

- (OFData *) readDataUntilEndOfStream

Returns OFData with all the remaining data of the stream.

Returns: OFData with an item size of 1 with all the data of the stream until the end of the stream is reached.

Exceptions

OFReadFailedException	Reading failed
OFNotOpenException	The stream is not open

◆ readDataWithCount:

- (OFData *) readDataWithCount: (size_t) count

Reads the specified number of items with an item size of 1 from the stream and returns them as OFData.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Parameters

count The number of items to read

Returns: OFData with count items.

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readDataWithItemSize:count:

- (OFData *) readDataWithItemSize:		(size_t)	itemSize
count:		(size_t)	count

Reads the specified number of items with the specified item size from the stream and returns them as OFData.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Parameters

itemSize	The size of each item
count	The number of items to read

Returns: OFData with count items.

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readInt8

- (uint8_t) readInt8

Reads a uint8_t from the stream.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A uint8_t from the stream

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readIntoBuffer:exactLength:

- (void) readIntoBuffer:		(void *)	buffer
exactLength:		(size_t)	length

Reads exactly the specified length bytes from the stream into a buffer.

Unlike readIntoBuffer:length:, this method does not return when less than the specified length has been read - instead, it waits until it got exactly the specified length.

Warning: Only call this when you know that specified amount of data is available! Otherwise you will get an exception!

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read. The buffer must be at least this big!

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading the specified amount
OFNotOpenException	The stream is not open

◆ readIntoBuffer:length:

- (size_t) readIntoBuffer:		(void *)	buffer
length:		(size_t)	length

Reads at most length bytes from the stream into a buffer.

On network streams, this might read less than the specified number of bytes. If you want to read exactly the specified number of bytes, use readIntoBuffer:exactLength:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read at most. The buffer must be at least this big!

Returns: The number of bytes read

Exceptions

OFReadFailedException	Reading failed
OFNotOpenException	The stream is not open

◆ readLine

- (OFString *) readLine

Reads until a newline, \0 or end of stream occurs.

Returns: The line that was read, autoreleased, or nil if the end of the stream has been reached.

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ readLineWithEncoding:

- (OFString *) readLineWithEncoding: (OFStringEncoding) encoding

Reads with the specified encoding until a newline, \0 or end of stream occurs.

Parameters

encoding The encoding used by the stream

Returns: The line that was read, autoreleased, or nil if the end of the stream has been reached.

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ readLittleEndianDouble

- (double) readLittleEndianDouble

Reads a double from the stream which is encoded in little endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A double from the stream in little endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readLittleEndianFloat

- (float) readLittleEndianFloat

Reads a float from the stream which is encoded in little endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A float from the stream in little endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readLittleEndianInt16

- (uint16_t) readLittleEndianInt16

Reads a uint16_t from the stream which is encoded in little endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A uint16_t from the stream in little endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readLittleEndianInt32

- (uint32_t) readLittleEndianInt32

Reads a uint32_t from the stream which is encoded in little endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A uint32_t from the stream in little endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readLittleEndianInt64

- (uint64_t) readLittleEndianInt64

Reads a uint64_t from the stream which is encoded in little endian.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Returns: A uint64_t from the stream in little endian

Exceptions

OFReadFailedException	Reading failed
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readString

- (OFString *) readString

Reads a string until a \0 appears in the stream or the end of the stream is reached.

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

Reimplemented in OFHTTPResponse.

◆ readStringWithEncoding:

- (OFString *) readStringWithEncoding: (OFStringEncoding) encoding

Reads a string with the specified encoding until a \0 appears in the stream or the end of the stream is reached.

Parameters

encoding The encoding of the string to read from the stream

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

Reimplemented in OFHTTPResponse.

◆ readStringWithLength:

- (OFString *) readStringWithLength: (size_t) length

Reads a string with the specified length from the stream.

If \0 appears in the stream, the string will be truncated at the \0 and the rest of the bytes of the string will be lost. This way, reading from the stream will not break because of a \0 because the specified number of bytes is still being read and only the string gets truncated.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Parameters

length The length (in bytes) of the string to read from the stream

Returns: A string with the specified length

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readStringWithLength:encoding:

- (OFString *) readStringWithLength:		(size_t)	length
encoding:		(OFStringEncoding)	encoding

Reads a string with the specified encoding and length from the stream.

If a \0 appears in the stream, the string will be truncated at the \0 and the rest of the bytes of the string will be lost. This way, reading from the stream will not break because of a \0 because the specified number of bytes is still being read and only the string gets truncated.

Warning: Only call this when you know that enough data is available! Otherwise you will get an exception!

Parameters

encoding	The encoding of the string to read from the stream
length	The length (in bytes) of the string to read from the stream

Returns: A string with the specified length

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFTruncatedDataException	The end of the stream was reached before reading enough bytes
OFNotOpenException	The stream is not open

◆ readUntilDelimiter:

- (OFString *) readUntilDelimiter: (OFString *) delimiter

Reads until the specified string or \0 is found or the end of stream occurs.

Parameters

delimiter The delimiter

Returns: The string that was read, autoreleased, or nil if the end of the stream has been reached.

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ readUntilDelimiter:encoding:

- (OFString *) readUntilDelimiter:		(OFString *)	delimiter
encoding:		(OFStringEncoding)	encoding

Reads until the specified string or \0 is found or the end of stream occurs.

Parameters

delimiter	The delimiter
encoding	The encoding used by the stream

Returns: The string that was read, autoreleased, or nil if the end of the stream has been reached.

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ tryReadLine

- (OFString *) tryReadLine

Tries to read a line from the stream (see readLine) and returns nil if no complete line has been received yet.

Returns: The line that was read, autoreleased, or nil if the line is not complete yet

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ tryReadLineWithEncoding:

- (OFString *) tryReadLineWithEncoding: (OFStringEncoding) encoding

Tries to read a line from the stream with the specified encoding (see readLineWithEncoding:) and returns nil if no complete line has been received yet.

Parameters

encoding The encoding used by the stream

Returns: The line that was read, autoreleased, or nil if the line is not complete yet

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ tryReadString

- (OFString *) tryReadString

Tries to read a string until a \0 appears in the stream or the end of the stream is reached.

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ tryReadStringWithEncoding:

- (OFString *) tryReadStringWithEncoding: (OFStringEncoding) encoding

Tries to read a string with the specified encoding until a \0 appears in the stream or the end of the stream is reached.

Parameters

encoding The encoding of the string to read from the stream

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ tryReadUntilDelimiter:

- (OFString *) tryReadUntilDelimiter: (OFString *) delimiter

Tries to reads until the specified string or \0 is found or the end of stream (see readUntilDelimiter:) and returns nil if not enough data has been received yet.

Parameters

delimiter The delimiter

Returns: The string that was read, autoreleased, or nil if the end of the stream has been reached.

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ tryReadUntilDelimiter:encoding:

- (OFString *) tryReadUntilDelimiter:		(OFString *)	delimiter
encoding:		(OFStringEncoding)	encoding

Tries to read until the specified string or \0 is found or the end of stream occurs (see readUntilDelimiter:encoding:) and returns nil if not enough data has been received yet.

Parameters

delimiter	The delimiter
encoding	The encoding used by the stream

Returns: The string that was read, autoreleased, or nil if the end of the stream has been reached.

Exceptions

OFReadFailedException	Reading failed
OFInvalidEncodingException	The string read from the stream has invalid encoding
OFNotOpenException	The stream is not open

◆ unreadFromBuffer:length:

- (void) unreadFromBuffer:		(const void *)	buffer
length:		(size_t)	length

"Reverses" a read operation, meaning the bytes from the specified buffer will be returned on the next read operation.

This is useful for reading into a buffer, parsing the data and then giving back the data which does not need to be processed. This can be used to optimize situations in which the length of the data that needs to be processed is not known before all data has been processed - for example in decompression - in which it would otherwise be necessary to read byte by byte to avoid consuming bytes that need to be parsed by something else - for example the data descriptor in a ZIP archive which immediately follows the compressed data.

If the stream is a file, this method does not change any data in the file.

If the stream is seekable, a seek operation will discard any data which was unread.

Parameters

buffer	The buffer to unread
length	The length of the buffer to unread

◆ writeBigEndianDouble:

- (void) writeBigEndianDouble: (double) double_

Writes a double into the stream, encoded in big endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

double_ A double

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeBigEndianFloat:

- (void) writeBigEndianFloat: (float) float_

Writes a float into the stream, encoded in big endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

float_ A float

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeBigEndianInt16:

- (void) writeBigEndianInt16: (uint16_t) int16

Writes a uint16_t into the stream, encoded in big endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

int16 A uint16_t

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeBigEndianInt32:

- (void) writeBigEndianInt32: (uint32_t) int32

Writes a uint32_t into the stream, encoded in big endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

int32 A uint32_t

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeBigEndianInt64:

- (void) writeBigEndianInt64: (uint64_t) int64

Writes a uint64_t into the stream, encoded in big endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

int64 A uint64_t

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeBuffer:length:

- (void) writeBuffer:		(const void *)	buffer
length:		(size_t)	length

Writes from a buffer into the stream.

In non-blocking mode, if less than the specified length could be written, an OFWriteFailedException is thrown with OFWriteFailedException::errNo being set to EWOULDBLOCK or EAGAIN (you need to check for both, as they are not the same on some systems) and OFWriteFailedException::bytesWritten being set to the number of bytes that were written, if any.

Parameters

buffer	The buffer from which the data is written into the stream
length	The length of the data that should be written

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeData:

- (void) writeData: (OFData *) data

Writes OFData into the stream.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

data	The OFData to write into the stream

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeFormat:

- (void) writeFormat:		(OFConstantString *)	format
,		(...)

Writes a formatted string into the stream.

See printf for the format syntax. As an addition, %@ is available as format specifier for objects, C for OFUnichar and S for const OFUnichar *.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

format A string used as format

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open
OFInvalidFormatException	The specified format is invalid

◆ writeFormat:arguments:

- (void) writeFormat:		(OFConstantString *)	format
arguments:		(va_list)	arguments

Writes a formatted string into the stream.

See printf for the format syntax. As an addition, %@ is available as format specifier for objects, C for OFUnichar and S for const OFUnichar *.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

format	A string used as format
arguments	The arguments used in the format string

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open
OFInvalidFormatException	The specified format is invalid

◆ writeInt8:

- (void) writeInt8: (uint8_t) int8

Writes a uint8_t into the stream.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

int8 A uint8_t

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeLine:

- (void) writeLine: (OFString *) string

Writes a string into the stream with a trailing newline.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

string The string from which the data is written to the stream

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeLine:encoding:

- (void) writeLine:		(OFString *)	string
encoding:		(OFStringEncoding)	encoding

Writes a string into the stream in the specified encoding with a trailing newline.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

string	The string from which the data is written to the stream
encoding	The encoding in which to write the string to the stream

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeLittleEndianDouble:

- (void) writeLittleEndianDouble: (double) double_

Writes a double into the stream, encoded in little endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

double_ A double

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeLittleEndianFloat:

- (void) writeLittleEndianFloat: (float) float_

Writes a float into the stream, encoded in little endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

float_ A float

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeLittleEndianInt16:

- (void) writeLittleEndianInt16: (uint16_t) int16

Writes a uint16_t into the stream, encoded in little endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

int16 A uint16_t

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeLittleEndianInt32:

- (void) writeLittleEndianInt32: (uint32_t) int32

Writes a uint32_t into the stream, encoded in little endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

int32 A uint32_t

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeLittleEndianInt64:

- (void) writeLittleEndianInt64: (uint64_t) int64

Writes a uint64_t into the stream, encoded in little endian.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

int64 A uint64_t

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeString:

- (void) writeString: (OFString *) string

Writes a string into the stream, without the trailing zero.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

string The string from which the data is written to the stream

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

◆ writeString:encoding:

- (void) writeString:		(OFString *)	string
encoding:		(OFStringEncoding)	encoding

Writes a string into the stream in the specified encoding, without the trailing zero.

In non-blocking mode, the behavior is the same as writeBuffer:length:.

Parameters

string	The string from which the data is written to the stream
encoding	The encoding in which to write the string to the stream

Exceptions

OFWriteFailedException	Writing failed
OFNotOpenException	The stream is not open

Property Documentation

◆ canBlock

- (bool) canBlock

readwritenonatomicassign

Whether the stream can block.

By default, a stream can block. On Win32, setting this currently only works for sockets!

Exceptions

OFGetOptionFailedException	The option could not be retrieved
OFSetOptionFailedException	The option could not be set

◆ delegate

- (id<OFStreamDelegate>) delegate

readwriteatomic

The delegate for asynchronous operations on the stream.

Note: The delegate is retained for as long as asynchronous operations are still ongoing.

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

src/OFStream.h
src/OFStream.m

Instance Methods

Properties

Additional Inherited Members

Detailed Description

Method Documentation

◆ asyncReadIntoBuffer:exactLength:

◆ asyncReadIntoBuffer:exactLength:block:

◆ asyncReadIntoBuffer:exactLength:handler:

◆ asyncReadIntoBuffer:exactLength:runLoopMode:

◆ asyncReadIntoBuffer:exactLength:runLoopMode:block:

◆ asyncReadIntoBuffer:exactLength:runLoopMode:handler:

◆ asyncReadIntoBuffer:length:

◆ asyncReadIntoBuffer:length:block:

◆ asyncReadIntoBuffer:length:handler:

◆ asyncReadIntoBuffer:length:runLoopMode:

◆ asyncReadIntoBuffer:length:runLoopMode:block:

◆ asyncReadIntoBuffer:length:runLoopMode:handler:

◆ asyncReadLine

◆ asyncReadLineWithBlock:

◆ asyncReadLineWithEncoding:

◆ asyncReadLineWithEncoding:block:

◆ asyncReadLineWithEncoding:handler:

◆ asyncReadLineWithEncoding:runLoopMode:

◆ asyncReadLineWithEncoding:runLoopMode:block:

◆ asyncReadLineWithEncoding:runLoopMode:handler:

◆ asyncReadLineWithHandler:

◆ asyncReadString

◆ asyncReadStringWithEncoding:

◆ asyncReadStringWithEncoding:handler:

◆ asyncReadStringWithEncoding:runLoopMode:

◆ asyncReadStringWithEncoding:runLoopMode:handler:

◆ asyncReadStringWithHandler:

◆ asyncWriteData:

◆ asyncWriteData:block:

◆ asyncWriteData:handler:

◆ asyncWriteData:runLoopMode:

◆ asyncWriteData:runLoopMode:block:

◆ asyncWriteData:runLoopMode:handler:

◆ asyncWriteString:

◆ asyncWriteString:block:

◆ asyncWriteString:encoding:

◆ asyncWriteString:encoding:block:

◆ asyncWriteString:encoding:handler:

◆ asyncWriteString:encoding:runLoopMode:

◆ asyncWriteString:encoding:runLoopMode:block:

◆ asyncWriteString:encoding:runLoopMode:handler:

◆ asyncWriteString:handler:

◆ close

◆ flushWriteBuffer

◆ lowlevelHasDataInReadBuffer

◆ lowlevelIsAtEndOfStream

◆ lowlevelReadIntoBuffer:length:

◆ lowlevelWriteBuffer:length:

◆ readBigEndianDouble

◆ readBigEndianFloat

◆ readBigEndianInt16

◆ readBigEndianInt32

◆ readBigEndianInt64

◆ readDataUntilEndOfStream

◆ readDataWithCount:

◆ readDataWithItemSize:count:

◆ readInt8

◆ readIntoBuffer:exactLength:

◆ readIntoBuffer:length:

◆ readLine

◆ readLineWithEncoding:

◆ readLittleEndianDouble

◆ readLittleEndianFloat

◆ readLittleEndianInt16

◆ readLittleEndianInt32

◆ readLittleEndianInt64

◆ readString

◆ readStringWithEncoding:

◆ readStringWithLength:

◆ readStringWithLength:encoding:

◆ readUntilDelimiter:

◆ readUntilDelimiter:encoding:

◆ tryReadLine

◆ tryReadLineWithEncoding:

◆ tryReadString