Wraps another input stream, and reads from it using an intermediate buffer. More...
Inherits InputStream.
Public Member Functions | |
| BufferedInputStream (InputStream *sourceStream, int bufferSize, bool deleteSourceWhenDestroyed) | |
| Creates a BufferedInputStream from an input source. | |
| BufferedInputStream (InputStream &sourceStream, int bufferSize) | |
| Creates a BufferedInputStream from an input source. | |
| ~BufferedInputStream () | |
| Destructor. | |
| int64 | getTotalLength () |
| Returns the total number of bytes available for reading in this stream. | |
| int64 | getPosition () |
| Returns the offset of the next byte that will be read from the stream. | |
| bool | setPosition (int64 newPosition) |
| Tries to move the current read position of the stream. | |
| int | read (void *destBuffer, int maxBytesToRead) |
| Reads a set of bytes from the stream into a memory buffer. | |
| String | readString () |
| Reads a zero-terminated UTF8 string from the stream. | |
| bool | isExhausted () |
| Returns true if the stream has no more data to read. | |
Wraps another input stream, and reads from it using an intermediate buffer.
If you're using an input stream such as a file input stream, and making lots of small read accesses to it, it's probably sensible to wrap it in one of these, so that the source stream gets accessed in larger chunk sizes, meaning less work for the underlying stream.
| BufferedInputStream::BufferedInputStream | ( | InputStream * | sourceStream, |
| int | bufferSize, | ||
| bool | deleteSourceWhenDestroyed | ||
| ) |
Creates a BufferedInputStream from an input source.
| sourceStream | the source stream to read from |
| bufferSize | the size of reservoir to use to buffer the source |
| deleteSourceWhenDestroyed | whether the sourceStream that is passed in should be deleted by this object when it is itself deleted. |
| BufferedInputStream::BufferedInputStream | ( | InputStream & | sourceStream, |
| int | bufferSize | ||
| ) |
Creates a BufferedInputStream from an input source.
| sourceStream | the source stream to read from - the source stream must not be deleted until this object has been destroyed. |
| bufferSize | the size of reservoir to use to buffer the source |
| BufferedInputStream::~BufferedInputStream | ( | ) |
Destructor.
This may also delete the source stream, if that option was chosen when the buffered stream was created.
| int64 BufferedInputStream::getTotalLength | ( | ) | [virtual] |
Returns the total number of bytes available for reading in this stream.
Note that this is the number of bytes available from the start of the stream, not from the current position.
If the size of the stream isn't actually known, this may return -1.
Implements InputStream.
| int64 BufferedInputStream::getPosition | ( | ) | [virtual] |
Returns the offset of the next byte that will be read from the stream.
Implements InputStream.
| bool BufferedInputStream::setPosition | ( | int64 | newPosition ) | [virtual] |
Tries to move the current read position of the stream.
The position is an absolute number of bytes from the stream's start.
Some streams might not be able to do this, in which case they should do nothing and return false. Others might be able to manage it by resetting themselves and skipping to the correct position, although this is obviously a bit slow.
Implements InputStream.
| int BufferedInputStream::read | ( | void * | destBuffer, |
| int | maxBytesToRead | ||
| ) | [virtual] |
Reads a set of bytes from the stream into a memory buffer.
This is the only read method that subclasses actually need to implement, as the InputStream base class implements the other read methods in terms of this one (although it's often more efficient for subclasses to implement them directly).
| destBuffer | the destination buffer for the data |
| maxBytesToRead | the maximum number of bytes to read - make sure the memory block passed in is big enough to contain this many bytes. |
Implements InputStream.
| String BufferedInputStream::readString | ( | ) | [virtual] |
Reads a zero-terminated UTF8 string from the stream.
This will read characters from the stream until it hits a zero character or end-of-stream.
Reimplemented from InputStream.
| bool BufferedInputStream::isExhausted | ( | ) | [virtual] |
Returns true if the stream has no more data to read.
Implements InputStream.
