#import <ObjectiveLib/ZlibInStream.h>
Inheritance diagram for OLZlibInStream:
Public Member Functions | |
| (void) | - close |
| Close the stream. | |
| (void) | - freeStreamResources |
| Free the stream's resources. | |
| (unsigned) | - readBytes:count: |
| Read a sequence of bytes from the stream. | |
Initializers and Deallocators | |
| (id) | - initWithInStream: |
| Initialize the stream. | |
| (id) | - initWithInStream:bufferSize: |
| Initialize the stream. | |
| (id) | - initWithInStream:bufferSize:readZlibHeader: |
| Initialize the stream. | |
Static Public Member Functions | |
| (id) | + streamWithInStream: |
| Create and return a newly created stream. | |
Protected Attributes | |
| uint8_t * | buffer |
| The buffer required by zlib. | |
| unsigned | bufferSize |
| The size of the zlib buffer. | |
| z_stream_s * | zstream |
| The opaque data type used by zlib to represent the stream. | |
This is a concrete layered stream that decompresses all data read using the library zlib. It is suitable for reading data compressed with OLZlibOutStream.
| - (void) close |
Close the stream.
After receiving this message the stream will no long be available for reading.
| OLInputOutputException | if there is an error closing the stream |
Reimplemented from OLLayeredInStream.
| - (void) freeStreamResources |
Free the stream's resources.
This secondary freeing method is necessary to allow the reference count to be properly manipulated from within the normal free (OLReferenceCountedStream) method.
Reimplemented from OLLayeredInStream.
Reimplemented in OLGzipInStream.
| - (id) initWithInStream: | (OLInStream *) | underStream |
Initialize the stream.
The stream is created with a buffer size of 1,024. The given stream underStream will become the next layer down in the stack of streams.
| OLInputOutputException | if the stream cannot be created for inflation |
| underStream | the stream from which to read data |
Reimplemented from OLLayeredInStream.
| - (id) initWithInStream: | (OLInStream *) | underStream | ||
| bufferSize: | (unsigned) | size | ||
Initialize the stream.
The stream is created with the given buffer size. The given stream underStream will become the next layer down in the stack of streams.
| OLInputOutputException | if the stream cannot be created for inflation |
| underStream | the stream from which to read data | |
| size | the buffer size |
| - (id) initWithInStream: | (OLInStream *) | underStream | ||
| bufferSize: | (unsigned) | size | ||
| readZlibHeader: | (BOOL) | zlibHeader | ||
Initialize the stream.
The stream is created with the given buffer size. The given stream underStream will become the next layer down in the stack of streams. If zlibHeader is YES, then the stream will attempt to read the zlib header.
| OLInputOutputException | if the stream cannot be created for inflation |
| underStream | the stream from which to read data | |
| size | the buffer size | |
| zlibHeader | should be YES if the zlib header should be read from the stream, otherwise NO |
Reimplemented in OLGzipInStream.
| - (unsigned) readBytes: | (uint8_t *) | dest | ||
| count: | (unsigned) | max | ||
Read a sequence of bytes from the stream.
Bytes are decompressed up to the value of max and the number decompressed is returned. If no more bytes are available from the stream, then UINT_MAX is returned.
| OLInputOutputException | if there is an error reading from the stream |
| dest | the address to which the bytes should be read | |
| max | the maximum number bytes that should be read |
Reimplemented from OLLayeredInStream.
Reimplemented in OLGzipInStream.
| + (id) streamWithInStream: | (OLInStream *) | underStream |
Create and return a newly created stream.
The stream is created with a buffer size of 1,024. The given stream underStream will become the next layer down in the stack of streams.
| OLInputOutputException | if the stream cannot be created for inflation |
| underStream | the stream from which to read data |
Reimplemented in OLGzipInStream.
- (uint8_t*) buffer [protected] |
The buffer required by zlib.
- (unsigned) bufferSize [protected] |
The size of the zlib buffer.
- (struct z_stream_s*) zstream [protected] |
The opaque data type used by zlib to represent the stream.
|
