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

#import <OFStream.h>

Inheritance diagram for OFStream:

Instance Methods
(BOOL)	- isAtEndOfStream
	Returns a boolean whether the end of the stream has been reached.

(size_t)	- readIntoBuffer:length:
	Reads at most size 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:target:selector:
	Asyncronously reads at most size bytes from the stream into a buffer.

(void)	- asyncReadIntoBuffer:exactLength:target:selector:
	Asyncronously 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.

(size_t)	- readBigEndianInt16sIntoBuffer:count:
	Reads the specified number of uint16_ts from the stream which are encoded in big endian.

(size_t)	- readBigEndianInt32sIntoBuffer:count:
	Reads the specified number of uint32_ts from the stream which are encoded in big endian.

(size_t)	- readBigEndianInt64sIntoBuffer:count:
	Reads the specified number of uint64_ts from the stream which are encoded in big endian.

(size_t)	- readBigEndianFloatsIntoBuffer:count:
	Reads the specified number of floats from the stream which are encoded in big endian.

(size_t)	- readBigEndianDoublesIntoBuffer:count:
	Reads the specified number of doubles from the stream which are 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.

(size_t)	- readLittleEndianInt16sIntoBuffer:count:
	Reads the specified number of uint16_ts from the stream which are encoded in little endian.

(size_t)	- readLittleEndianInt32sIntoBuffer:count:
	Reads the specified number of uint32_ts from the stream which are encoded in little endian.

(size_t)	- readLittleEndianInt64sIntoBuffer:count:
	Reads the specified number of uint64_ts from the stream which are encoded in little endian.

(size_t)	- readLittleEndianFloatsIntoBuffer:count:
	Reads the specified number of floats from the stream which are encoded in little endian.

(size_t)	- readLittleEndianDoublesIntoBuffer:count:
	Reads the specified number of doubles from the stream which are encoded in little endian.

(OFDataArray *)	- readDataArrayWithSize:
	Reads the specified number of items with an item size of 1 from the stream and returns them in an OFDataArray.

(OFDataArray *)	- readDataArrayWithItemSize:count:
	Reads the specified number of items with the specified item size from the stream and returns them in an OFDataArray.

(OFDataArray *)	- readDataArrayTillEndOfStream
	Returns an OFDataArray with all the remaining data of the stream.

(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.

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

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

(void)	- asyncReadLineWithTarget:selector:
	Asyncronously reads until a newline, \0, end of stream or an exception occurs.

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

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

(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.

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

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

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

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

(BOOL)	- writeBufferEnabled
	Returns a boolen whether writes are buffered.

(void)	- setWriteBufferEnabled:
	Enables or disables the write buffer.

(void)	- flushWriteBuffer
	Writes everythig in the write buffer to the stream.

(void)	- writeBuffer:length:
	Writes from a buffer 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.

(size_t)	- writeBigEndianInt16s:count:
	Writes the specified number of uint16_ts into the stream, encoded in big endian.

(size_t)	- writeBigEndianInt32s:count:
	Writes the specified number of uint32_ts into the stream, encoded in big endian.

(size_t)	- writeBigEndianInt64s:count:
	Writes the specified number of uint64_ts into the stream, encoded in big endian.

(size_t)	- writeBigEndianFloats:count:
	Writes the specified number of floats into the stream, encoded in big endian.

(size_t)	- writeBigEndianDoubles:count:
	Writes the specified number of doubles 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.

(size_t)	- writeLittleEndianInt16s:count:
	Writes the specified number of uint16_ts into the stream, encoded in little endian.

(size_t)	- writeLittleEndianInt32s:count:
	Writes the specified number of uint32_ts into the stream, encoded in little endian.

(size_t)	- writeLittleEndianInt64s:count:
	Writes the specified number of uint64_ts into the stream, encoded in little endian.

(size_t)	- writeLittleEndianFloats:count:
	Writes the specified number of floats into the stream, encoded in little endian.

(size_t)	- writeLittleEndianDoubles:count:
	Writes the specified number of doubles into the stream, encoded in little endian.

(size_t)	- writeDataArray:
	Writes from an OFDataArray into the stream.

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

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

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

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

(size_t)	- pendingBytes
	Returns the number of bytes still present in the internal read cache.

(BOOL)	- isBlocking
	Returns whether the stream is in blocking mode.

(void)	- setBlocking:
	Enables or disables non-blocking I/O.

(int)	- fileDescriptorForReading
	Returns the file descriptor for the read end of the stream.

(int)	- fileDescriptorForWriting
	Returns the file descriptor for the write end of the stream.

(void)	- close
	Closes the stream.

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

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

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

Instance Methods inherited from OFObject
(id)	- init
	Initializes an already allocated object.

(OFString *)	- className
	Returns the name of the object's class.

(OFString *)	- description
	Returns a description for the object.

(void *)	- allocMemoryWithSize:
	Allocates memory and stores it in the object's memory pool.

(void *)	- allocMemoryWithSize:count:
	Allocates memory for the specified number of items and stores it in the object's memory pool.

(void *)	- resizeMemory:size:
	Resizes memory in the object's memory pool to the specified size.

(void *)	- resizeMemory:size:count:
	Resizes memory in the object's memory pool to the specific number of items of the specified size.

(void)	- freeMemory:
	Frees allocated memory and removes it from the object's memory pool.

(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: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)	- 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)	- 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.

(OFString *)	- stringBySerializing
	Creates a string by serializing the receiver.

Instance Methods inherited from <OFObject>
(BOOL)	- isKindOfClass:
	Returns a boolean whether the object 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.

(IMP)	- methodForSelector:
	Returns the implementation for the specified selector.

(const char *)	- typeEncodingForSelector:
	Returns the type encoding for the specified selector.

(id)	- performSelector:
	Performs the specified selector.

(id)	- performSelector:withObject:
	Performs the specified selector with the specified object.

(id)	- performSelector:withObject:withObject:
	Performs the specified selector with the specified objects.

(BOOL)	- isEqual:
	Checks two objects for equality.

(uint32_t)	- hash
	Calculates a hash for the object.

(id)	- retain
	Increases the retain count.

(unsigned int)	- retainCount
	Returns the retain count.

(void)	- release
	Decreases the retain count.

(id)	- autorelease
	Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack.

(id)	- self
	Returns the receiver.

(BOOL)	- isProxy
	Returns whether the object is a proxy object.

Instance Methods inherited from <OFCopying>
(id)	- copy
	Copies 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)	+ initialize
	A method which is called the moment before the first call to the class is being made.

(id)	+ alloc
	Allocates memory for an instance of the class and sets up the memory pool for the object.

(id)	+ new
	Allocates memory for a new instance and calls -[init] on it.

(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.

(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.

(IMP)	+ instanceMethodForSelector:
	Returns the implementation of the instance method for the specified selector.

(const char *)	+ typeEncodingForInstanceSelector:
	Returns the type encoding of the instance method for the specified selector.

(OFString *)	+ description
	Returns a description for the class, which is usually the class name.

(IMP)	+ replaceClassMethod:withMethodFromClass:
	Replaces a class method with a class method from another class.

(IMP)	+ replaceInstanceMethod:withMethodFromClass:
	Replaces an instance method with an instance method from another class.

(IMP)	+ replaceClassMethod:withImplementation:typeEncoding:
	Replaces or adds a class method.

(IMP)	+ replaceInstanceMethod:withImplementation:typeEncoding:
	Replaces or adds an instance method.

(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.

Public Attributes inherited from OFObject
Class	isa
	The class of the object.

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:, lowlevelWriteBuffer:length: and lowlevelIsAtEndOfStream, 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

- (void) asyncReadIntoBuffer:	(void*)	buffer
exactLength:	(size_t)	length
target:	(id)	target
selector:	(SEL)	selector

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

Unlike asyncReadIntoBuffer:length:block, 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.

Parameters

buffer	The buffer into which the data is read
length	The length of the data that should be read. The buffer must be exactly this big!
target	The target on which the selector should be called when the data has been received. If the method returns YES, it will be called again with the same buffer and exact length when more data has been received. If you want the next method in the queue to handle the data received next, you need to return NO from the method.
selector	The selector to call on the target. The signature must be BOOL (OFStream stream, void buffer, size_t size, OFException *exception).

- (void) asyncReadIntoBuffer:	(void*)	buffer
length:	(size_t)	length
target:	(id)	target
selector:	(SEL)	selector

Asyncronously reads at most size 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: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 isAtEndOfStream.

Parameters

buffer	The buffer into which the data is read. The buffer must not be free'd 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!
target	The target on which the selector should be called when the data has been received. If the method returns YES, it will be called again with the same buffer and maximum length when more data has been received. If you want the next method in the queue to handle the data received next, you need to return NO from the method.
selector	The selector to call on the target. The signature must be BOOL (OFStream stream, void buffer, size_t size, OFException *exception).

- (void) asyncReadLineWithEncoding:	(of_string_encoding_t)	encoding
target:	(id)	target
selector:	(SEL)	selector

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

Parameters

encoding	The encoding used by the stream
target	The target on which to call the selector when the data has been received. If the method returns YES, it will be called again when the next line has been received. If you want the next method in the queue to handle the next line, you need to return NO from the method
selector	The selector to call on the target. The signature must be BOOL (OFStream stream, OFString line, OFException *exception).

- (void) asyncReadLineWithTarget:	(id)	target
selector:	(SEL)	selector

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

Parameters

target	The target on which to call the selector when the data has been received. If the method returns YES, it will be called again when the next line has been received. If you want the next method in the queue to handle the next line, you need to return NO from the method
selector	The selector to call on the target. The signature must be BOOL (OFStream stream, OFString line, OFException *exception).

- (int) fileDescriptorForReading

Returns the file descriptor for the read end of the stream.

Returns: The file descriptor for the read end of the stream

- (int) fileDescriptorForWriting

Returns the file descriptor for the write end of the stream.

Returns: The file descriptor for the write end of the stream

- (BOOL) isAtEndOfStream

Returns a boolean whether the end of the stream has been reached.

Returns: A boolean whether the end of the stream has been reached

- (BOOL) isBlocking

Returns whether the stream is in blocking mode.

Returns: Whether the stream is in blocking mode

- (BOOL) lowlevelIsAtEndOfStream

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

Warning: Do not call this directly!

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

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

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

Performs a lowlevel read.

Warning: Do not call this directly!

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

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

Performs a lowlevel write.

Warning: Do not call this directly!

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

- (size_t) pendingBytes

Returns the number of bytes still present in the internal read cache.

Returns: The number of bytes still present in the internal read cache.

- (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 the native endianess

- (size_t) readBigEndianDoublesIntoBuffer:	(double*)	buffer
count:	(size_t)	nDoubles

Reads the specified number of doubles from the stream which are encoded in big endian.

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

Parameters

nDoubles	The number of doubles to read
buffer	A buffer of sufficient size to store the specified number of doubles

Returns: The number of bytes read

- (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 the native endianess

- (size_t) readBigEndianFloatsIntoBuffer:	(float*)	buffer
count:	(size_t)	nFloats

Reads the specified number of floats from the stream which are encoded in big endian.

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

Parameters

nFloatss	The number of floats to read
buffer	A buffer of sufficient size to store the specified number of floats

Returns: The number of bytes read

- (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 native endianess

- (size_t) readBigEndianInt16sIntoBuffer:	(uint16_t*)	buffer
count:	(size_t)	nInt16s

Reads the specified number of uint16_ts from the stream which are encoded in big endian.

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

Parameters

nInt16s	The number of uint16_ts to read
buffer	A buffer of sufficient size to store the specified number of uint16_ts

Returns: The number of bytes read

- (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 the native endianess

- (size_t) readBigEndianInt32sIntoBuffer:	(uint32_t*)	buffer
count:	(size_t)	nInt32s

Reads the specified number of uint32_ts from the stream which are encoded in big endian.

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

Parameters

nInt32s	The number of uint32_ts to read
buffer	A buffer of sufficient size to store the specified number of uint32_ts

Returns: The number of bytes read

- (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 the native endianess

- (size_t) readBigEndianInt64sIntoBuffer:	(uint64_t*)	buffer
count:	(size_t)	nInt64s

Reads the specified number of uint64_ts from the stream which are encoded in big endian.

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

Parameters

nInt64s	The number of uint64_ts to read
buffer	A buffer of sufficient size to store the specified number of uint64_ts

Returns: The number of bytes read

- (OFDataArray *) readDataArrayTillEndOfStream

Returns an OFDataArray with all the remaining data of the stream.

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

- (OFDataArray *) readDataArrayWithItemSize:	(size_t)	itemSize
count:	(size_t)	nItems

Reads the specified number of items with the specified item size from the stream and returns them in an OFDataArray.

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
nItems	The number of items to read

Returns: An OFDataArray with at nItems items.

- (OFDataArray *) readDataArrayWithSize: (size_t) size

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

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

Parameters

nItems The number of items to read

Returns: An OFDataArray with at nItems items.

- (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

- (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 exactly this big!

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

Reads at most size 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 isAtEndOfStream.

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

- (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.

- (OFString *) readLineWithEncoding: (of_string_encoding_t) 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.

- (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 the native endianess

- (size_t) readLittleEndianDoublesIntoBuffer:	(double*)	buffer
count:	(size_t)	nDoubles

Reads the specified number of doubles from the stream which are encoded in little endian.

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

Parameters

nDoubles	The number of doubles to read
buffer	A buffer of sufficient size to store the specified number of doubles

Returns: The number of bytes read

- (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 the native endianess

- (size_t) readLittleEndianFloatsIntoBuffer:	(float*)	buffer
count:	(size_t)	nFloats

Reads the specified number of floats from the stream which are encoded in little endian.

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

Parameters

nFloats	The number of floats to read
buffer	A buffer of sufficient size to store the specified number of floats

Returns: The number of bytes read

- (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 native endianess

- (size_t) readLittleEndianInt16sIntoBuffer:	(uint16_t*)	buffer
count:	(size_t)	nInt16s

Reads the specified number of uint16_ts from the stream which are encoded in little endian.

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

Parameters

nInt16s	The number of uint16_ts to read
buffer	A buffer of sufficient size to store the specified number of uint16_ts

Returns: The number of bytes read

- (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 the native endianess

- (size_t) readLittleEndianInt32sIntoBuffer:	(uint32_t*)	buffer
count:	(size_t)	nInt32s

Reads the specified number of uint32_ts from the stream which are encoded in little endian.

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

Parameters

nInt32s	The number of uint32_ts to read
buffer	A buffer of sufficient size to store the specified number of uint32_ts

Returns: The number of bytes read

- (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 the native endianess

- (size_t) readLittleEndianInt64sIntoBuffer:	(uint64_t*)	buffer
count:	(size_t)	nInt64s

Reads the specified number of uint64_ts from the stream which are encoded in little endian.

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

Parameters

nInt64s	The number of uint64_ts to read
buffer	A buffer of sufficient size to store the specified number of uint64_ts

Returns: The number of bytes read

- (OFString *) readStringWithLength: (size_t) length

Reads a string with the specified 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

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

Returns: A string with the specified length

- (OFString *) readStringWithLength:	(size_t)	length
encoding:	(of_string_encoding_t)	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

- (OFString *) readTillDelimiter: (OFString*) delimiter

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

Parameters

delimiter The delimiter

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

- (OFString *) readTillDelimiter:	(OFString*)	delimiter
encoding:	(of_string_encoding_t)	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 line that was read, autoreleased, or nil if the end of the stream has been reached.

- (void) setBlocking: (BOOL) enable

Enables or disables non-blocking I/O.

By default, a stream is in blocking mode. On Win32, this currently only works for sockets!

Parameters

enable Whether the stream should be blocking

- (void) setWriteBufferEnabled: (BOOL) enable

Enables or disables the write buffer.

Parameters

enable Whether the write buffer should be enabled or disabled

- (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

- (OFString *) tryReadLineWithEncoding: (of_string_encoding_t) 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

- (OFString *) tryReadTillDelimiter: (OFString*) delimiter

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

Parameters

delimiter The delimiter

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

- (OFString *) tryReadTillDelimiter:	(OFString*)	delimiter
encoding:	(of_string_encoding_t)	encoding

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

Parameters

delimiter	The delimiter
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.

- (void) writeBigEndianDouble: (double) double_

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

Parameters

double_ A double

- (size_t) writeBigEndianDoubles:	(const double*)	buffer
count:	(size_t)	nDoubles

Writes the specified number of doubles into the stream, encoded in big endian.

Parameters

nDoubles	The number of doubles to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (void) writeBigEndianFloat: (float) float_

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

Parameters

float_ A float

- (size_t) writeBigEndianFloats:	(const float*)	buffer
count:	(size_t)	nFloats

Writes the specified number of floats into the stream, encoded in big endian.

Parameters

nFloats	The number of floats to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (void) writeBigEndianInt16: (uint16_t) int16

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

Parameters

int16 A uint16_t

- (size_t) writeBigEndianInt16s:	(const uint16_t*)	buffer
count:	(size_t)	nInt16s

Writes the specified number of uint16_ts into the stream, encoded in big endian.

Parameters

nInt16	The number of uint16_ts to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (void) writeBigEndianInt32: (uint32_t) int32

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

Parameters

int32 A uint32_t

- (size_t) writeBigEndianInt32s:	(const uint32_t*)	buffer
count:	(size_t)	nInt32s

Writes the specified number of uint32_ts into the stream, encoded in big endian.

Parameters

nInt32	The number of uint32_ts to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (void) writeBigEndianInt64: (uint64_t) int64

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

Parameters

int64 A uint64_t

- (size_t) writeBigEndianInt64s:	(const uint64_t*)	buffer
count:	(size_t)	nInt64s

Writes the specified number of uint64_ts into the stream, encoded in big endian.

Parameters

nInt64	The number of uint64_ts to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

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

Writes from a buffer into the stream.

Parameters

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

- (BOOL) writeBufferEnabled

Returns a boolen whether writes are buffered.

Returns: A boolean whether writes are buffered

- (size_t) writeDataArray: (OFDataArray*) dataArray

Writes from an OFDataArray into the stream.

Parameters

dataArray The OFDataArray to write into the stream

Returns: The number of bytes written

- (size_t) 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.

Parameters

format A string used as format

Returns: The number of bytes written

- (size_t) 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.

Parameters

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

Returns: The number of bytes written

- (void) writeInt8: (uint8_t) int8

Writes a uint8_t into the stream.

Parameters

int8 A uint8_t

- (size_t) writeLine: (OFString*) string

Writes a string into the stream with a trailing newline.

Parameters

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

Returns: The number of bytes written

- (void) writeLittleEndianDouble: (double) double_

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

Parameters

double_ A double

- (size_t) writeLittleEndianDoubles:	(const double*)	buffer
count:	(size_t)	nDoubles

Writes the specified number of doubles into the stream, encoded in little endian.

Parameters

nDoubles	The number of doubles to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (void) writeLittleEndianFloat: (float) float_

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

Parameters

float_ A float

- (size_t) writeLittleEndianFloats:	(const float*)	buffer
count:	(size_t)	nFloats

Writes the specified number of floats into the stream, encoded in little endian.

Parameters

nFloats	The number of floats to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (void) writeLittleEndianInt16: (uint16_t) int16

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

Parameters

int16 A uint16_t

- (size_t) writeLittleEndianInt16s:	(const uint16_t*)	buffer
count:	(size_t)	nInt16s

Writes the specified number of uint16_ts into the stream, encoded in little endian.

Parameters

nInt16	The number of uint16_ts to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (void) writeLittleEndianInt32: (uint32_t) int32

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

Parameters

int32 A uint32_t

- (size_t) writeLittleEndianInt32s:	(const uint32_t*)	buffer
count:	(size_t)	nInt32s

Writes the specified number of uint32_ts into the stream, encoded in little endian.

Parameters

nInt32	The number of uint32_ts to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (void) writeLittleEndianInt64: (uint64_t) int64

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

Parameters

int64 A uint64_t

- (size_t) writeLittleEndianInt64s:	(const uint64_t*)	buffer
count:	(size_t)	nInt64s

Writes the specified number of uint64_ts into the stream, encoded in little endian.

Parameters

nInt64	The number of uint64_ts to write
buffer	The buffer from which the data is written to the stream after it has been byte swapped if necessary

Returns: The number of bytes written to the stream

- (size_t) writeString: (OFString*) string

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

Parameters

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

Returns: The number of bytes written

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

src/OFStream.h
src/OFStream.m

Instance Methods

Additional Inherited Members

Detailed Description

Method Documentation