ObjFW
Instance Methods | List of all members
OFStream Class Reference

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

#import <ObjFW/OFStream.h>

Inheritance diagram for OFStream:
OFObject <OFReadyForReadingObserving> <OFReadyForWritingObserving> <OFCopying> <OFObject> <OFObject> <OFObject> OFHTTPResponse OFInflateStream OFProcess OFSeekableStream OFStdIOStream OFStreamSocket OFInflate64Stream OFFile OFTCPSocket

Instance Methods

(bool) - isAtEndOfStream
 Returns a boolean whether the end of the stream has been reached. More...
 
(size_t) - readIntoBuffer:length:
 Reads at most size bytes from the stream into a buffer. More...
 
(void) - readIntoBuffer:exactLength:
 Reads exactly the specified length bytes from the stream into a buffer. More...
 
(void) - asyncReadIntoBuffer:length:target:selector:
 Asyncronously reads at most size bytes from the stream into a buffer. More...
 
(void) - asyncReadIntoBuffer:exactLength:target:selector:
 Asyncronously reads exactly the specified length bytes from the stream into a buffer. More...
 
(void) - asyncReadIntoBuffer:length:block:
 Asyncronously reads at most ref size bytes from the stream into a buffer. More...
 
(void) - asyncReadIntoBuffer:exactLength:block:
 Asyncronously reads exactly the specified length bytes from the stream into a buffer. More...
 
(uint8_t) - readInt8
 Reads a uint8_t from the stream. More...
 
(uint16_t) - readBigEndianInt16
 Reads a uint16_t from the stream which is encoded in big endian. More...
 
(uint32_t) - readBigEndianInt32
 Reads a uint32_t from the stream which is encoded in big endian. More...
 
(uint64_t) - readBigEndianInt64
 Reads a uint64_t from the stream which is encoded in big endian. More...
 
(float) - readBigEndianFloat
 Reads a float from the stream which is encoded in big endian. More...
 
(double) - readBigEndianDouble
 Reads a double from the stream which is encoded in big endian. More...
 
(size_t) - readBigEndianInt16sIntoBuffer:count:
 Reads the specified number of uint16_ts from the stream which are encoded in big endian. More...
 
(size_t) - readBigEndianInt32sIntoBuffer:count:
 Reads the specified number of uint32_ts from the stream which are encoded in big endian. More...
 
(size_t) - readBigEndianInt64sIntoBuffer:count:
 Reads the specified number of uint64_ts from the stream which are encoded in big endian. More...
 
(size_t) - readBigEndianFloatsIntoBuffer:count:
 Reads the specified number of floats from the stream which are encoded in big endian. More...
 
(size_t) - readBigEndianDoublesIntoBuffer:count:
 Reads the specified number of doubles from the stream which are encoded in big endian. More...
 
(uint16_t) - readLittleEndianInt16
 Reads a uint16_t from the stream which is encoded in little endian. More...
 
(uint32_t) - readLittleEndianInt32
 Reads a uint32_t from the stream which is encoded in little endian. More...
 
(uint64_t) - readLittleEndianInt64
 Reads a uint64_t from the stream which is encoded in little endian. More...
 
(float) - readLittleEndianFloat
 Reads a float from the stream which is encoded in little endian. More...
 
(double) - readLittleEndianDouble
 Reads a double from the stream which is encoded in little endian. More...
 
(size_t) - readLittleEndianInt16sIntoBuffer:count:
 Reads the specified number of uint16_ts from the stream which are encoded in little endian. More...
 
(size_t) - readLittleEndianInt32sIntoBuffer:count:
 Reads the specified number of uint32_ts from the stream which are encoded in little endian. More...
 
(size_t) - readLittleEndianInt64sIntoBuffer:count:
 Reads the specified number of uint64_ts from the stream which are encoded in little endian. More...
 
(size_t) - readLittleEndianFloatsIntoBuffer:count:
 Reads the specified number of floats from the stream which are encoded in little endian. More...
 
(size_t) - readLittleEndianDoublesIntoBuffer:count:
 Reads the specified number of doubles from the stream which are encoded in little endian. More...
 
(OFDataArray *) - readDataArrayWithCount:
 Reads the specified number of items with an item size of 1 from the stream and returns them in an OFDataArray. More...
 
(OFDataArray *) - readDataArrayWithItemSize:count:
 Reads the specified number of items with the specified item size from the stream and returns them in an OFDataArray. More...
 
(OFDataArray *) - readDataArrayTillEndOfStream
 Returns an OFDataArray with all the remaining data of the stream. More...
 
(OFString *) - readStringWithLength:
 Reads a string with the specified length from the stream. More...
 
(OFString *) - readStringWithLength:encoding:
 Reads a string with the specified encoding and length from the stream. More...
 
(nullable OFString *) - readLine
 Reads until a newline, \0 or end of stream occurs. More...
 
(nullable OFString *) - readLineWithEncoding:
 Reads with the specified encoding until a newline, \0 or end of stream occurs. More...
 
(void) - asyncReadLineWithTarget:selector:
 Asyncronously reads until a newline, \0, end of stream or an exception occurs. More...
 
(void) - asyncReadLineWithEncoding:target:selector:
 Asyncronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs. More...
 
(void) - asyncReadLineWithBlock:
 Asyncronously reads until a newline, \0, end of stream or an exception occurs. More...
 
(void) - asyncReadLineWithEncoding:block:
 Asyncronously reads with the specified encoding until a newline, \0, end of stream or an exception occurs. More...
 
(nullable OFString *) - tryReadLine
 Tries to read a line from the stream (see readLine) and returns nil if no complete line has been received yet. More...
 
(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. More...
 
(nullable OFString *) - readTillDelimiter:
 Reads until the specified string or \0 is found or the end of stream occurs. More...
 
(nullable OFString *) - readTillDelimiter:encoding:
 Reads until the specified string or \0 is found or the end of stream occurs. More...
 
(nullable 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. More...
 
(nullable OFString *) - tryReadTillDelimiter:encoding:
 Tries to read until the specified string or \0 is found or the end of stream occurs (see readTillDelimiter:encoding:) and returns nil if not enough data has been received yet. More...
 
(bool) - isWriteBuffered
 Returns a boolen whether writes are buffered. More...
 
(void) - setWriteBuffered:
 Enables or disables the write buffer. More...
 
(void) - flushWriteBuffer
 Writes everythig in the write buffer to the stream.
 
(void) - writeBuffer:length:
 Writes from a buffer into the stream. More...
 
(void) - writeInt8:
 Writes a uint8_t into the stream. More...
 
(void) - writeBigEndianInt16:
 Writes a uint16_t into the stream, encoded in big endian. More...
 
(void) - writeBigEndianInt32:
 Writes a uint32_t into the stream, encoded in big endian. More...
 
(void) - writeBigEndianInt64:
 Writes a uint64_t into the stream, encoded in big endian. More...
 
(void) - writeBigEndianFloat:
 Writes a float into the stream, encoded in big endian. More...
 
(void) - writeBigEndianDouble:
 Writes a double into the stream, encoded in big endian. More...
 
(size_t) - writeBigEndianInt16s:count:
 Writes the specified number of uint16_ts into the stream, encoded in big endian. More...
 
(size_t) - writeBigEndianInt32s:count:
 Writes the specified number of uint32_ts into the stream, encoded in big endian. More...
 
(size_t) - writeBigEndianInt64s:count:
 Writes the specified number of uint64_ts into the stream, encoded in big endian. More...
 
(size_t) - writeBigEndianFloats:count:
 Writes the specified number of floats into the stream, encoded in big endian. More...
 
(size_t) - writeBigEndianDoubles:count:
 Writes the specified number of doubles into the stream, encoded in big endian. More...
 
(void) - writeLittleEndianInt16:
 Writes a uint16_t into the stream, encoded in little endian. More...
 
(void) - writeLittleEndianInt32:
 Writes a uint32_t into the stream, encoded in little endian. More...
 
(void) - writeLittleEndianInt64:
 Writes a uint64_t into the stream, encoded in little endian. More...
 
(void) - writeLittleEndianFloat:
 Writes a float into the stream, encoded in little endian. More...
 
(void) - writeLittleEndianDouble:
 Writes a double into the stream, encoded in little endian. More...
 
(size_t) - writeLittleEndianInt16s:count:
 Writes the specified number of uint16_ts into the stream, encoded in little endian. More...
 
(size_t) - writeLittleEndianInt32s:count:
 Writes the specified number of uint32_ts into the stream, encoded in little endian. More...
 
(size_t) - writeLittleEndianInt64s:count:
 Writes the specified number of uint64_ts into the stream, encoded in little endian. More...
 
(size_t) - writeLittleEndianFloats:count:
 Writes the specified number of floats into the stream, encoded in little endian. More...
 
(size_t) - writeLittleEndianDoubles:count:
 Writes the specified number of doubles into the stream, encoded in little endian. More...
 
(size_t) - writeDataArray:
 Writes from an OFDataArray into the stream. More...
 
(size_t) - writeString:
 Writes a string into the stream, without the trailing zero. More...
 
(size_t) - writeString:encoding:
 Writes a string into the stream in the specified encoding, without the trailing zero. More...
 
(size_t) - writeLine:
 Writes a string into the stream with a trailing newline. More...
 
(size_t) - writeLine:encoding:
 Writes a string into the stream in the specified encoding with a trailing newline. More...
 
(size_t) - writeFormat:
 Writes a formatted string into the stream. More...
 
(size_t) - writeFormat:arguments:
 Writes a formatted string into the stream. More...
 
(bool) - hasDataInReadBuffer
 Returns whether data is present in the internal read buffer. More...
 
(bool) - isBlocking
 Returns whether the stream is in blocking mode. More...
 
(void) - setBlocking:
 Enables or disables non-blocking I/O. More...
 
(int) - fileDescriptorForReading
 Returns the file descriptor for the read end of the stream. More...
 
(int) - fileDescriptorForWriting
 Returns the file descriptor for the write end of the stream. More...
 
(void) - cancelAsyncRequests
 Cancels all pending asyncronous requests on the stream. More...
 
(void) - unreadFromBuffer:length:
 "Reverses" a read operation, meaning the bytes from the specified buffer will be returned on the next read operation. More...
 
(void) - close
 Closes the stream.
 
(size_t) - lowlevelReadIntoBuffer:length:
 Performs a lowlevel read. More...
 
(void) - lowlevelWriteBuffer:length:
 Performs a lowlevel write. More...
 
(bool) - lowlevelIsAtEndOfStream
 Returns whether the lowlevel is at the end of the stream. More...
 
- Instance Methods inherited from OFObject
(id) - init
 Initializes an already allocated object. More...
 
(OFString *) - className
 Returns the name of the object's class. More...
 
(OFString *) - description
 Returns a description for the object. More...
 
(void *) - allocMemoryWithSize:
 Allocates memory and stores it in the object's memory pool. More...
 
(void *) - allocMemoryWithSize:count:
 Allocates memory for the specified number of items and stores it in the object's memory pool. More...
 
(nullable void *) - resizeMemory:size:
 Resizes memory in the object's memory pool to the specified size. More...
 
(nullable void *) - resizeMemory:size:count:
 Resizes memory in the object's memory pool to the specific number of items of the specified size. More...
 
(void) - freeMemory:
 Frees allocated memory and removes it from the object's memory pool. More...
 
(void) - dealloc
 Deallocates the object. More...
 
(void) - performSelector:afterDelay:
 Performs the specified selector after the specified delay. More...
 
(void) - performSelector:withObject:afterDelay:
 Performs the specified selector with the specified object after the specified delay. More...
 
(void) - performSelector:withObject:withObject:afterDelay:
 Performs the specified selector with the specified objects after the specified delay. More...
 
(void) - performSelector:onThread:waitUntilDone:
 Performs the specified selector on the specified thread. More...
 
(void) - performSelector:onThread:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified object. More...
 
(void) - performSelector:onThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the specified thread with the specified objects. More...
 
(void) - performSelectorOnMainThread:waitUntilDone:
 Performs the specified selector on the main thread. More...
 
(void) - performSelectorOnMainThread:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified object. More...
 
(void) - performSelectorOnMainThread:withObject:withObject:waitUntilDone:
 Performs the specified selector on the main thread with the specified objects. More...
 
(void) - performSelector:onThread:afterDelay:
 Performs the specified selector on the specified thread after the specified delay. More...
 
(void) - performSelector:onThread:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified object after the specified delay. More...
 
(void) - performSelector:onThread:withObject:withObject:afterDelay:
 Performs the specified selector on the specified thread with the specified objects after the specified delay. More...
 
(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. More...
 
(void) - doesNotRecognizeSelector:
 Handles messages which are not understood by the receiver. More...
 
(OFString *) - stringBySerializing
 Creates a string by serializing the receiver. More...
 
- Instance Methods inherited from <OFObject>
(bool) - isKindOfClass:
 Returns a boolean whether the object of the specified kind. More...
 
(bool) - isMemberOfClass:
 Returns a boolean whether the object is a member of the specified class. More...
 
(bool) - respondsToSelector:
 Returns a boolean whether the object responds to the specified selector. More...
 
(nullable IMP) - methodForSelector:
 Returns the implementation for the specified selector. More...
 
(nullable const char *) - typeEncodingForSelector:
 Returns the type encoding for the specified selector. More...
 
(nullable id) - performSelector:
 Performs the specified selector. More...
 
(nullable id) - performSelector:withObject:
 Performs the specified selector with the specified object. More...
 
(nullable id) - performSelector:withObject:withObject:
 Performs the specified selector with the specified objects. More...
 
(bool) - isEqual:
 Checks two objects for equality. More...
 
(uint32_t) - hash
 Calculates a hash for the object. More...
 
(id) - retain
 Increases the retain count. More...
 
(unsigned int) - retainCount
 Returns the retain count. More...
 
(void) - release
 Decreases the retain count. More...
 
(id) - autorelease
 Adds the object to the topmost OFAutoreleasePool of the thread's autorelease pool stack. More...
 
(id) - self
 Returns the receiver. More...
 
(bool) - isProxy
 Returns whether the object is a proxy object. More...
 
- Instance Methods inherited from <OFCopying>
(id) - copy
 Copies the object. More...
 

Additional Inherited Members

- Class Methods inherited from OFObject
(void) + load
 A method which is called once when the class is loaded into the runtime. More...
 
(void) + unload
 A method which is called when the class is unloaded from the runtime. More...
 
(void) + initialize
 A method which is called the moment before the first call to the class is being made. More...
 
(id) + alloc
 Allocates memory for an instance of the class and sets up the memory pool for the object. More...
 
(id) + new
 Allocates memory for a new instance and calls init on it. More...
 
(Class) + class
 Returns the class. More...
 
(OFString *) + className
 Returns the name of the class as a string. More...
 
(bool) + isSubclassOfClass:
 Returns a boolean whether the class is a subclass of the specified class. More...
 
(Class) + superclass
 Returns the superclass of the class. More...
 
(bool) + instancesRespondToSelector:
 Checks whether instances of the class respond to a given selector. More...
 
(bool) + conformsToProtocol:
 Checks whether the class conforms to a given protocol. More...
 
(nullable IMP) + instanceMethodForSelector:
 Returns the implementation of the instance method for the specified selector. More...
 
(nullable const char *) + typeEncodingForInstanceSelector:
 Returns the type encoding of the instance method for the specified selector. More...
 
(OFString *) + description
 Returns a description for the class, which is usually the class name. More...
 
(nullable IMP) + replaceClassMethod:withMethodFromClass:
 Replaces a class method with a class method from another class. More...
 
(nullable IMP) + replaceInstanceMethod:withMethodFromClass:
 Replaces an instance method with an instance method from another class. More...
 
(nullable IMP) + replaceClassMethod:withImplementation:typeEncoding:
 Replaces or adds a class method. More...
 
(nullable IMP) + replaceInstanceMethod:withImplementation:typeEncoding:
 Replaces or adds an instance method. More...
 
(void) + inheritMethodsFromClass:
 Adds all methods from the specified class to the class that is the receiver. More...
 
(bool) + resolveClassMethod:
 Try to resolve the specified class method. More...
 
(bool) + resolveInstanceMethod:
 Try to resolve the specified instance method. More...
 
(id) + copy
 Returns the class. More...
 

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

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

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

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 implement fileDescriptorForReading and return a valid file descriptor in order for this to work!
Parameters
bufferThe buffer into which the data is read
lengthThe length of the data that should be read. The buffer must be at least this big!
blockThe 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.
- (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:target:selector:, 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 implement fileDescriptorForReading and return a valid file descriptor in order for this to work!
Parameters
bufferThe buffer into which the data is read
lengthThe length of the data that should be read. The buffer must be at least this big!
targetThe target on which the selector should be called when the data has been received. If the method 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 method in the queue to handle the data received next, you need to return false from the method.
selectorThe 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
block: (of_stream_async_read_block_t block 

Asyncronously reads at most ref 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.

Note
The stream must implement fileDescriptorForReading and return a valid file descriptor in order for this to work!
Parameters
bufferThe buffer into which the data is read. The buffer must not be free'd before the async read completed!
lengthThe length of the data that should be read at most. The buffer must be at least this big!
blockThe 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.
- (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.

Note
The stream must implement fileDescriptorForReading and return a valid file descriptor in order for this to work!
Parameters
bufferThe buffer into which the data is read. The buffer must not be free'd before the async read completed!
lengthThe length of the data that should be read at most. The buffer must be at least this big!
targetThe target on which the selector should be called when the data has been received. If the method 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 method in the queue to handle the data received next, you need to return false from the method.
selectorThe selector to call on the target. The signature must be bool (OFStream *stream, void *buffer, size_t length, OFException *exception).
- (void) asyncReadLineWithBlock: (of_stream_async_read_line_block_t block

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

Note
The stream must implement fileDescriptorForReading and return a valid file descriptor in order for this to work!
Parameters
blockThe 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.
- (void) asyncReadLineWithEncoding: (of_string_encoding_t encoding
block: (of_stream_async_read_line_block_t block 

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

Note
The stream must implement fileDescriptorForReading and return a valid file descriptor in order for this to work!
Parameters
encodingThe encoding used by the stream
blockThe 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.
- (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.

Note
The stream must implement fileDescriptorForReading and return a valid file descriptor in order for this to work!
Parameters
encodingThe encoding used by the stream
targetThe target on which to call the selector when the data has been received. If the method returns true, 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 false from the method
selectorThe 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.

Note
The stream must implement fileDescriptorForReading and return a valid file descriptor in order for this to work!
Parameters
targetThe target on which to call the selector when the data has been received. If the method returns true, 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 false from the method
selectorThe selector to call on the target. The signature must be bool (OFStream *stream, OFString *line, OFException *exception).
- (void) cancelAsyncRequests

Cancels all pending asyncronous requests on the stream.

Warning
You are not allowed to call this inside the handler of an asyncronous request, as this would cancel the asyncronous request that is currently being handled! To cancel all pending asyncronous requests after the handler has finished executing, you may schedule a timer for this method with a timeout of 0 from inside the handler.
- (int) fileDescriptorForReading

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

Returns
The file descriptor for the read end of the stream

Reimplemented from <OFReadyForReadingObserving>.

- (int) fileDescriptorForWriting

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

Returns
The file descriptor for the write end of the stream

Reimplemented from <OFReadyForWritingObserving>.

- (bool) hasDataInReadBuffer

Returns whether data is present in the internal read buffer.

Returns
Whether data is present in the internal read buffer
- (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) isWriteBuffered

Returns a boolen whether writes are buffered.

Returns
A boolean whether writes are buffered
- (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
bufferThe buffer for the data to read
lengthThe 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
bufferThe buffer with the data to write
lengthThe length of the data to write
- (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)  count 

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
bufferA buffer of sufficient size to store the specified number of doubles
countThe number of doubles to read
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)  count 

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
bufferA buffer of sufficient size to store the specified number of floats
countThe number of floats to read
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)  count 

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
bufferA buffer of sufficient size to store the specified number of uint16_ts
countThe number of uint16_ts to read
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)  count 

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
bufferA buffer of sufficient size to store the specified number of uint32_ts
countThe number of uint32_ts to read
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)  count 

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
bufferA buffer of sufficient size to store the specified number of uint64_ts
countThe number of uint64_ts to read
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 *) readDataArrayWithCount: (size_t)  count

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
countThe number of items to read
Returns
An OFDataArray with count items.
- (OFDataArray *) readDataArrayWithItemSize: (size_t)  itemSize
count: (size_t)  count 

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
itemSizeThe size of each item
countThe number of items to read
Returns
An OFDataArray with count 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
bufferThe buffer into which the data is read
lengthThe length of the data that should be read. The buffer must be at least this big!
- (size_t) readIntoBuffer: (void*)  buffer
length: (size_t)  length 

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
bufferThe buffer into which the data is read
lengthThe 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
encodingThe 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)  count 

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
bufferA buffer of sufficient size to store the specified number of doubles
countThe number of doubles to read
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)  count 

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
bufferA buffer of sufficient size to store the specified number of floats
countThe number of floats to read
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)  count 

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
bufferA buffer of sufficient size to store the specified number of uint16_ts
countThe number of uint16_ts to read
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)  count 

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
bufferA buffer of sufficient size to store the specified number of uint32_ts
countThe number of uint32_ts to read
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)  count 

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
bufferA buffer of sufficient size to store the specified number of uint64_ts
countThe number of uint64_ts to read
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
lengthThe 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
encodingThe encoding of the string to read from the stream
lengthThe 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
delimiterThe 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
delimiterThe delimiter
encodingThe 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
enableWhether the stream should be blocking
- (void) setWriteBuffered: (bool)  enable

Enables or disables the write buffer.

Parameters
enableWhether 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
encodingThe 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
delimiterThe 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 readTillDelimiter:encoding:) and returns nil if not enough data has been received yet.

Parameters
delimiterThe delimiter
encodingThe encoding used by the stream
Returns
The line that was read, autoreleased, or nil if the end of the stream has been reached.
- (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
bufferThe buffer to unread
lengthThe length of the buffer to unread
- (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)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of doubles to write
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)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of floats to write
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
int16A uint16_t
- (size_t) writeBigEndianInt16s: (const uint16_t*)  buffer
count: (size_t)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of uint16_ts to write
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
int32A uint32_t
- (size_t) writeBigEndianInt32s: (const uint32_t*)  buffer
count: (size_t)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of uint32_ts to write
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
int64A uint64_t
- (size_t) writeBigEndianInt64s: (const uint64_t*)  buffer
count: (size_t)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of uint64_ts to write
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
bufferThe buffer from which the data is written to the stream
lengthThe length of the data that should be written
- (size_t) writeDataArray: (OFDataArray*)  dataArray

Writes from an OFDataArray into the stream.

Parameters
dataArrayThe 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, C for of_unichar_t and S for const of_unichar_t*.

Parameters
formatA 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, C for of_unichar_t and S for const of_unichar_t*.

Parameters
formatA string used as format
argumentsThe 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
int8A uint8_t
- (size_t) writeLine: (OFString*)  string

Writes a string into the stream with a trailing newline.

Parameters
stringThe string from which the data is written to the stream
Returns
The number of bytes written
- (size_t) writeLine: (OFString*)  string
encoding: (of_string_encoding_t encoding 

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

Parameters
stringThe string from which the data is written to the stream
encodingThe encoding in which to write the string 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)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of doubles to write
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)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of floats to write
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
int16A uint16_t
- (size_t) writeLittleEndianInt16s: (const uint16_t*)  buffer
count: (size_t)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of uint16_ts to write
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
int32A uint32_t
- (size_t) writeLittleEndianInt32s: (const uint32_t*)  buffer
count: (size_t)  count 

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

Parameters
countThe number of uint32_ts to write
bufferThe 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
int64A uint64_t
- (size_t) writeLittleEndianInt64s: (const uint64_t*)  buffer
count: (size_t)  count 

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

Parameters
bufferThe buffer from which the data is written to the stream after it has been byte swapped if necessary
countThe number of uint64_ts to write
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
stringThe string from which the data is written to the stream
Returns
The number of bytes written
- (size_t) writeString: (OFString*)  string
encoding: (of_string_encoding_t encoding 

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

Parameters
stringThe string from which the data is written to the stream
encodingThe encoding in which to write the string to the stream
Returns
The number of bytes written

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