ObjFW
|
A base class for different types of streams. More...
#import <ObjFW/OFStream.h>
Instance Methods | |
(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: |
Asynchronously reads at most size bytes from the stream into a buffer. More... | |
(void) | - asyncReadIntoBuffer:length:runLoopMode: |
Asynchronously reads at most size bytes from the stream into a buffer. More... | |
(void) | - asyncReadIntoBuffer:exactLength: |
Asynchronously reads exactly the specified length bytes from the stream into a buffer. More... | |
(void) | - asyncReadIntoBuffer:exactLength:runLoopMode: |
Asynchronously reads exactly the specified length bytes from the stream into a buffer. More... | |
(void) | - asyncReadIntoBuffer:length:block: |
Asynchronously reads at most ref size bytes from the stream into a buffer. More... | |
(void) | - asyncReadIntoBuffer:length:runLoopMode:block: |
Asynchronously reads at most ref size bytes from the stream into a buffer. More... | |
(void) | - asyncReadIntoBuffer:exactLength:block: |
Asynchronously reads exactly the specified length bytes from the stream into a buffer. More... | |
(void) | - asyncReadIntoBuffer:exactLength:runLoopMode:block: |
Asynchronously 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... | |
(OFData *) | - readDataWithCount: |
Reads the specified number of items with an item size of 1 from the stream and returns them as OFData. More... | |
(OFData *) | - readDataWithItemSize:count: |
Reads the specified number of items with the specified item size from the stream and returns them as OFData. More... | |
(OFData *) | - readDataUntilEndOfStream |
Returns OFData 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) | - asyncReadLine |
Asynchronously reads until a newline, \0 , end of stream or an exception occurs. More... | |
(void) | - asyncReadLineWithEncoding: |
Asynchronously reads with the specified encoding until a newline, \0 , end of stream or an exception occurs. More... | |
(void) | - asyncReadLineWithEncoding:runLoopMode: |
Asynchronously reads with the specified encoding until a newline, \0 , end of stream or an exception occurs. More... | |
(void) | - asyncReadLineWithBlock: |
Asynchronously reads until a newline, \0 , end of stream or an exception occurs. More... | |
(void) | - asyncReadLineWithEncoding:block: |
Asynchronously reads with the specified encoding until a newline, \0 , end of stream or an exception occurs. More... | |
(void) | - asyncReadLineWithEncoding:runLoopMode:block: |
Asynchronously 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... | |
(void) | - flushWriteBuffer |
Writes everything in the write buffer to the stream. | |
(size_t) | - writeBuffer:length: |
Writes from a buffer into the stream. More... | |
(void) | - asyncWriteData: |
Asynchronously writes data into the stream. More... | |
(void) | - asyncWriteData:runLoopMode: |
Asynchronously writes data into the stream. More... | |
(void) | - asyncWriteString: |
Asynchronously writes a string in UTF-8 encoding into the stream. More... | |
(void) | - asyncWriteString:encoding: |
Asynchronously writes a string in the specified encoding into the stream. More... | |
(void) | - asyncWriteString:encoding:runLoopMode: |
Asynchronously writes a string in the specified encoding into the stream. More... | |
(void) | - asyncWriteData:block: |
Asynchronously writes data into the stream. More... | |
(void) | - asyncWriteData:runLoopMode:block: |
Asynchronously writes data into the stream. More... | |
(void) | - asyncWriteString:block: |
Asynchronously writes a string into the stream. More... | |
(void) | - asyncWriteString:encoding:block: |
Asynchronously writes a string in the specified encoding into the stream. More... | |
(void) | - asyncWriteString:encoding:runLoopMode:block: |
Asynchronously writes a string in the specified encoding 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) | - writeData: |
Writes OFData 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... | |
(void) | - cancelAsyncRequests |
Cancels all pending asynchronous requests on the stream. | |
(void) | - unreadFromBuffer:length: |
"Reverses" a read operation, meaning the bytes from the specified buffer will be returned on the next read operation. More... | |
(void) | - close |
Closes the stream. More... | |
(size_t) | - lowlevelReadIntoBuffer:length: |
Performs a lowlevel read. More... | |
(size_t) | - lowlevelWriteBuffer:length: |
Performs a lowlevel write. More... | |
(bool) | - lowlevelIsAtEndOfStream |
Returns whether the lowlevel is at the end of the stream. More... | |
![]() | |
(instancetype) | - init |
Initializes an already allocated object. More... | |
(nullable OFMethodSignature *) | - methodSignatureForSelector: |
Returns the method signature for the specified selector. 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:withObject:withObject:withObject:afterDelay: |
Performs the specified selector with the specified objects after the specified delay. More... | |
(void) | - performSelector:withObject:withObject: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) | - performSelector:onThread:withObject:withObject:withObject:waitUntilDone: |
Performs the specified selector on the specified thread with the specified objects. More... | |
(void) | - performSelector:onThread:withObject:withObject: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) | - performSelectorOnMainThread:withObject:withObject:withObject:waitUntilDone: |
Performs the specified selector on the main thread with the specified objects. More... | |
(void) | - performSelectorOnMainThread:withObject:withObject: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... | |
(void) | - performSelector:onThread:withObject:withObject:withObject:afterDelay: |
Performs the specified selector on the specified thread with the specified objects after the specified delay. More... | |
(void) | - performSelector:onThread:withObject:withObject: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... | |
![]() | |
(unsigned long) | - hash |
Returns a 32 bit hash for the object. More... | |
(unsigned int) | - retainCount |
Returns the retain count. More... | |
(bool) | - isProxy |
Returns whether the object is a proxy object. More... | |
(bool) | - allowsWeakReference |
Returns whether the object allows weak references. More... | |
(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 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... | |
(nullable id) | - performSelector:withObject:withObject:withObject: |
Performs the specified selector with the specified objects. More... | |
(nullable id) | - performSelector:withObject:withObject:withObject:withObject: |
Performs the specified selector with the specified objects. More... | |
(bool) | - isEqual: |
Checks two objects for equality. More... | |
(instancetype) | - retain |
Increases the retain count. More... | |
(void) | - release |
Decreases the retain count. More... | |
(instancetype) | - autorelease |
Adds the object to the topmost autorelease pool of the thread's autorelease pool stack. More... | |
(instancetype) | - self |
Returns the receiver. More... | |
(bool) | - retainWeakReference |
Retain a weak reference to this object. More... | |
![]() | |
(id) | - copy |
Copies the object. More... | |
Properties | |
bool | atEndOfStream |
Whether the end of the stream has been reached. | |
bool | buffersWrites |
Whether writes are buffered. | |
bool | hasDataInReadBuffer |
Whether data is present in the internal read buffer. | |
bool | canBlock |
Whether the stream can block. More... | |
id< OFStreamDelegate > | delegate |
The delegate for asynchronous operations on the stream. More... | |
![]() | |
OFString * | className |
The name of the object's class. | |
OFString * | description |
A description for the object. More... | |
OFString * | stringBySerializing |
The object serialized as a string. | |
Additional Inherited Members | |
![]() | |
(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... | |
(instancetype) | + alloc |
Allocates memory for an instance of the class and sets up the memory pool for the object. More... | |
(instancetype) | + new |
Calls alloc on self and then init on the returned object. 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... | |
(nullable 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 OFMethodSignature *) | + instanceMethodSignatureForSelector: |
Returns the method signature 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... | |
(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... | |
A base class for different types of streams.
lowlevel
prefix, you will break caching and get broken results! - (void) asyncReadIntoBuffer: | (void *) | buffer | |
exactLength: | (size_t) | length | |
Asynchronously reads exactly the specified length bytes from the stream into a buffer.
Unlike asyncReadIntoBuffer:length:, this method does not call the method when less than the specified length has been read - instead, it waits until it got exactly the specified length, the stream has ended or an exception occurred.
buffer | The buffer into which the data is read |
length | The length of the data that should be read. The buffer must be at least this big! |
- (void) asyncReadIntoBuffer: | (void *) | buffer | |
exactLength: | (size_t) | length | |
block: | (of_stream_async_read_block_t) | block | |
Asynchronously 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.
buffer | The buffer into which the data is read |
length | The length of the data that should be read. The buffer must be at least this big! |
block | The block to call when the data has been received. If the block returns true, it will be called again with the same buffer and exact length when more data has been received. If you want the next block in the queue to handle the data received next, you need to return false from the block. |
- (void) asyncReadIntoBuffer: | (void *) | buffer | |
exactLength: | (size_t) | length | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
Asynchronously reads exactly the specified length bytes from the stream into a buffer.
Unlike asyncReadIntoBuffer:length:, this method does not call the method when less than the specified length has been read - instead, it waits until it got exactly the specified length, the stream has ended or an exception occurred.
buffer | The buffer into which the data is read |
length | The length of the data that should be read. The buffer must be at least this big! |
runLoopMode | The run loop mode in which to perform the async read |
- (void) asyncReadIntoBuffer: | (void *) | buffer | |
exactLength: | (size_t) | length | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
block: | (of_stream_async_read_block_t) | block | |
Asynchronously 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.
buffer | The buffer into which the data is read |
length | The length of the data that should be read. The buffer must be at least this big! |
runLoopMode | The run loop mode in which to perform the async read |
block | The block to call when the data has been received. If the block returns true, it will be called again with the same buffer and exact length when more data has been received. If you want the next block in the queue to handle the data received next, you need to return false from the block. |
- (void) asyncReadIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
Asynchronously 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:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.
buffer | The buffer into which the data is read. The buffer must not be freed before the async read completed! |
length | The length of the data that should be read at most. The buffer must be at least this big! |
- (void) asyncReadIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
block: | (of_stream_async_read_block_t) | block | |
Asynchronously 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 atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.
buffer | The buffer into which the data is read. The buffer must not be freed before the async read completed! |
length | The length of the data that should be read at most. The buffer must be at least this big! |
block | The block to call when the data has been received. If the block returns true, it will be called again with the same buffer and maximum length when more data has been received. If you want the next block in the queue to handle the data received next, you need to return false from the block. |
- (void) asyncReadIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
Asynchronously 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:. Note that a read can even return 0 bytes - this does not necessarily mean that the stream ended, so you still need to check atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.
buffer | The buffer into which the data is read. The buffer must not be freed before the async read completed! |
length | The length of the data that should be read at most. The buffer must be at least this big! |
runLoopMode | The run loop mode in which to perform the async read |
- (void) asyncReadIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
block: | (of_stream_async_read_block_t) | block | |
Asynchronously 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 atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.
buffer | The buffer into which the data is read. The buffer must not be freed before the async read completed! |
length | The length of the data that should be read at most. The buffer must be at least this big! |
runLoopMode | The run loop mode in which to perform the async read |
block | The block to call when the data has been received. If the block returns true, it will be called again with the same buffer and maximum length when more data has been received. If you want the next block in the queue to handle the data received next, you need to return false from the block. |
- (void) asyncReadLine |
Asynchronously reads until a newline, \0
, end of stream or an exception occurs.
- (void) asyncReadLineWithBlock: | (of_stream_async_read_line_block_t) | block |
Asynchronously reads until a newline, \0
, end of stream or an exception occurs.
block | The block to call when the data has been received. If the block returns true, it will be called again when the next line has been received. If you want the next block in the queue to handle the next line, you need to return false from the block. |
- (void) asyncReadLineWithEncoding: | (of_string_encoding_t) | encoding |
Asynchronously reads with the specified encoding until a newline, \0
, end of stream or an exception occurs.
encoding | The encoding used by the stream |
- (void) asyncReadLineWithEncoding: | (of_string_encoding_t) | encoding | |
block: | (of_stream_async_read_line_block_t) | block | |
Asynchronously reads with the specified encoding until a newline, \0
, end of stream or an exception occurs.
encoding | The encoding used by the stream |
block | The block to call when the data has been received. If the block returns true, it will be called again when the next line has been received. If you want the next block in the queue to handle the next line, you need to return false from the block. |
- (void) asyncReadLineWithEncoding: | (of_string_encoding_t) | encoding | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
Asynchronously reads with the specified encoding until a newline, \0
, end of stream or an exception occurs.
encoding | The encoding used by the stream |
runLoopMode | The run loop mode in which to perform the async read |
- (void) asyncReadLineWithEncoding: | (of_string_encoding_t) | encoding | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
block: | (of_stream_async_read_line_block_t) | block | |
Asynchronously reads with the specified encoding until a newline, \0
, end of stream or an exception occurs.
encoding | The encoding used by the stream |
runLoopMode | The run loop mode in which to perform the async read |
block | The block to call when the data has been received. If the block returns true, it will be called again when the next line has been received. If you want the next block in the queue to handle the next line, you need to return false from the block. |
- (void) asyncWriteData: | (OFData *) | data |
Asynchronously writes data into the stream.
data | The data which is written into the stream |
- (void) asyncWriteData: | (OFData *) | data | |
block: | (of_stream_async_write_data_block_t) | block | |
Asynchronously writes data into the stream.
data | The data which is written into the stream |
block | The block to call when the data has been written. It should return the data for the next write with the same callback or nil if it should not repeat. |
- (void) asyncWriteData: | (OFData *) | data | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
Asynchronously writes data into the stream.
data | The data which is written into the stream |
runLoopMode | The run loop mode in which to perform the async write |
- (void) asyncWriteData: | (OFData *) | data | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
block: | (of_stream_async_write_data_block_t) | block | |
Asynchronously writes data into the stream.
data | The data which is written into the stream |
runLoopMode | The run loop mode in which to perform the async write |
block | The block to call when the data has been written. It should return the data for the next write with the same callback or nil if it should not repeat. |
- (void) asyncWriteString: | (OFString *) | string |
Asynchronously writes a string in UTF-8 encoding into the stream.
string | The string which is written into the stream |
- (void) asyncWriteString: | (OFString *) | string | |
block: | (of_stream_async_write_string_block_t) | block | |
Asynchronously writes a string into the stream.
string | The string which is written into the stream |
block | The block to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat. |
- (void) asyncWriteString: | (OFString *) | string | |
encoding: | (of_string_encoding_t) | encoding | |
Asynchronously writes a string in the specified encoding into the stream.
string | The string which is written into the stream |
encoding | The encoding in which the string should be written to the stream |
- (void) asyncWriteString: | (OFString *) | string | |
encoding: | (of_string_encoding_t) | encoding | |
block: | (of_stream_async_write_string_block_t) | block | |
Asynchronously writes a string in the specified encoding into the stream.
string | The string which is written into the stream |
encoding | The encoding in which the string should be written to the stream |
block | The block to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat. |
- (void) asyncWriteString: | (OFString *) | string | |
encoding: | (of_string_encoding_t) | encoding | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
Asynchronously writes a string in the specified encoding into the stream.
string | The string which is written into the stream |
encoding | The encoding in which the string should be written to the stream |
runLoopMode | The run loop mode in which to perform the async write |
- (void) asyncWriteString: | (OFString *) | string | |
encoding: | (of_string_encoding_t) | encoding | |
runLoopMode: | (of_run_loop_mode_t) | runLoopMode | |
block: | (of_stream_async_write_string_block_t) | block | |
Asynchronously writes a string in the specified encoding into the stream.
string | The string which is written into the stream |
encoding | The encoding in which the string should be written to the stream |
runLoopMode | The run loop mode in which to perform the async write |
block | The block to call when the string has been written. It should return the string for the next write with the same callback or nil if it should not repeat. |
- (void) close |
Closes the stream.
[super close]
! - (bool) lowlevelIsAtEndOfStream |
Returns whether the lowlevel is at the end of the stream.
- (size_t) lowlevelReadIntoBuffer: | (void *) | buffer | |
length: | (size_t) | length | |
Performs a lowlevel read.
buffer | The buffer for the data to read |
length | The length of the buffer |
- (size_t) lowlevelWriteBuffer: | (const void *) | buffer | |
length: | (size_t) | length | |
Performs a lowlevel write.
buffer | The buffer with the data to write |
length | The length of the data to write |
- (double) readBigEndianDouble |
Reads a double from the stream which is encoded in big endian.
- (size_t) readBigEndianDoublesIntoBuffer: | (double *) | buffer | |
count: | (size_t) | count | |
Reads the specified number of doubles from the stream which are encoded in big endian.
buffer | A buffer of sufficient size to store the specified number of doubles |
count | The number of doubles to read |
- (float) readBigEndianFloat |
Reads a float from the stream which is encoded in big endian.
- (size_t) readBigEndianFloatsIntoBuffer: | (float *) | buffer | |
count: | (size_t) | count | |
Reads the specified number of floats from the stream which are encoded in big endian.
buffer | A buffer of sufficient size to store the specified number of floats |
count | The number of floats to read |
- (uint16_t) readBigEndianInt16 |
Reads a uint16_t from the stream which is encoded in big endian.
- (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.
buffer | A buffer of sufficient size to store the specified number of uint16_ts |
count | The number of uint16_ts to read |
- (uint32_t) readBigEndianInt32 |
Reads a uint32_t from the stream which is encoded in big endian.
- (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.
buffer | A buffer of sufficient size to store the specified number of uint32_ts |
count | The number of uint32_ts to read |
- (uint64_t) readBigEndianInt64 |
Reads a uint64_t from the stream which is encoded in big endian.
- (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.
buffer | A buffer of sufficient size to store the specified number of uint64_ts |
count | The number of uint64_ts to read |
- (OFData *) readDataUntilEndOfStream |
- (OFData *) readDataWithCount: | (size_t) | count |
- (OFData *) readDataWithItemSize: | (size_t) | itemSize | |
count: | (size_t) | count | |
Reads the specified number of items with the specified item size from the stream and returns them as OFData.
itemSize | The size of each item |
count | The number of items to read |
- (uint8_t) readInt8 |
Reads 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.
buffer | The buffer into which the data is read |
length | The length of the data that should be read. The buffer must be at least this big! |
- (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 atEndOfStream. Do not assume that the stream ended just because a read returned 0 bytes - some streams do internal processing that has a result of 0 bytes.
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! |
- (OFString *) readLine |
Reads until a newline, \0
or end of stream occurs.
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.
encoding | The encoding used by the stream |
nil
if the end of the stream has been reached. - (double) readLittleEndianDouble |
Reads a double from the stream which is encoded in little endian.
- (size_t) readLittleEndianDoublesIntoBuffer: | (double *) | buffer | |
count: | (size_t) | count | |
Reads the specified number of doubles from the stream which are encoded in little endian.
buffer | A buffer of sufficient size to store the specified number of doubles |
count | The number of doubles to read |
- (float) readLittleEndianFloat |
Reads a float from the stream which is encoded in little endian.
- (size_t) readLittleEndianFloatsIntoBuffer: | (float *) | buffer | |
count: | (size_t) | count | |
Reads the specified number of floats from the stream which are encoded in little endian.
buffer | A buffer of sufficient size to store the specified number of floats |
count | The number of floats to read |
- (uint16_t) readLittleEndianInt16 |
Reads a uint16_t from the stream which is encoded in little endian.
- (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.
buffer | A buffer of sufficient size to store the specified number of uint16_ts |
count | The number of uint16_ts to read |
- (uint32_t) readLittleEndianInt32 |
Reads a uint32_t from the stream which is encoded in little endian.
- (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.
buffer | A buffer of sufficient size to store the specified number of uint32_ts |
count | The number of uint32_ts to read |
- (uint64_t) readLittleEndianInt64 |
Reads a uint64_t from the stream which is encoded in little endian.
- (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.
buffer | A buffer of sufficient size to store the specified number of uint64_ts |
count | The number of uint64_ts to read |
- (OFString *) readStringWithLength: | (size_t) | length |
Reads a string with the specified length from the stream.
If \0
appears in the stream, the string will be truncated at the \0
and the rest of the bytes of the string will be lost. This way, reading from the stream will not break because of a \0
because the specified number of bytes is still being read and only the string gets truncated.
length | The length (in bytes) of the string to read from the stream |
- (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.
encoding | The encoding of the string to read from the stream |
length | The length (in bytes) of the string to read from the stream |
Reads until the specified string or \0
is found or the end of stream occurs.
delimiter | The delimiter |
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.
delimiter | The delimiter |
encoding | The encoding used by the stream |
nil
if the end of the stream has been reached. - (OFString *) tryReadLine |
Tries to read a line from the stream (see readLine) and returns nil
if no complete line has been received yet.
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.
encoding | The encoding used by the stream |
nil
if the line is not complete yet 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.
delimiter | The delimiter |
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.
delimiter | The delimiter |
encoding | The encoding used by the stream |
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.
buffer | The buffer to unread |
length | The length of the buffer to unread |
- (void) writeBigEndianDouble: | (double) | double_ |
Writes a double into the stream, encoded in big endian.
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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of doubles to write |
- (void) writeBigEndianFloat: | (float) | float_ |
Writes a float into the stream, encoded in big endian.
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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of floats to write |
- (void) writeBigEndianInt16: | (uint16_t) | int16 |
Writes a uint16_t into the stream, encoded in big endian.
int16 | A 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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of uint16_ts to write |
- (void) writeBigEndianInt32: | (uint32_t) | int32 |
Writes a uint32_t into the stream, encoded in big endian.
int32 | A 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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of uint32_ts to write |
- (void) writeBigEndianInt64: | (uint64_t) | int64 |
Writes a uint64_t into the stream, encoded in big endian.
int64 | A 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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of uint64_ts to write |
- (size_t) writeBuffer: | (const void *) | buffer | |
length: | (size_t) | length | |
Writes from a buffer into the stream.
buffer | The buffer from which the data is written into the stream |
length | The length of the data that should be written |
- (size_t) writeData: | (OFData *) | data |
- (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 *
.
format | A string used as format |
- (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 *
.
format | A string used as format |
arguments | The arguments used in the format string |
- (void) writeInt8: | (uint8_t) | int8 |
Writes a uint8_t into the stream.
int8 | A uint8_t |
- (size_t) writeLine: | (OFString *) | string |
Writes a string into the stream with a trailing newline.
string | The string from which the data is written to the stream |
- (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.
string | The string from which the data is written to the stream |
encoding | The encoding in which to write the string to the stream |
- (void) writeLittleEndianDouble: | (double) | double_ |
Writes a double into the stream, encoded in little endian.
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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of doubles to write |
- (void) writeLittleEndianFloat: | (float) | float_ |
Writes a float into the stream, encoded in little endian.
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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of floats to write |
- (void) writeLittleEndianInt16: | (uint16_t) | int16 |
Writes a uint16_t into the stream, encoded in little endian.
int16 | A 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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of uint16_ts to write |
- (void) writeLittleEndianInt32: | (uint32_t) | int32 |
Writes a uint32_t into the stream, encoded in little endian.
int32 | A 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.
count | 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 |
- (void) writeLittleEndianInt64: | (uint64_t) | int64 |
Writes a uint64_t into the stream, encoded in little endian.
int64 | A 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.
buffer | The buffer from which the data is written to the stream after it has been byte swapped if necessary |
count | The number of uint64_ts to write |
- (size_t) writeString: | (OFString *) | string |
Writes a string into the stream, without the trailing zero.
string | The string from which the data is written to the stream |
- (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.
string | The string from which the data is written to the stream |
encoding | The encoding in which to write the string to the stream |
|
readwritenonatomicassign |
Whether the stream can block.
By default, a stream can block. On Win32, setting this currently only works for sockets!
|
readwriteatomic |
The delegate for asynchronous operations on the stream.