zipios::BackBuffer(3) | Library Functions Manual | zipios::BackBuffer(3) |
NAME¶
zipios::BackBuffer - A BackBuffer instance is useful for reading the last part of a file in an efficient manner, when it is not known exactly how far back (towards the front!) to go, to find the start of the desired data block.
SYNOPSIS¶
#include <backbuffer.h>
Inherits vector< unsigned char >.
Public Member Functions¶
BackBuffer (istream &is, VirtualSeeker
vs=VirtualSeeker(), int chunk_size=1024)
BackBuffer constructor. int readChunk (int
&read_pointer)
Reads another chunk and returns the size of the chunk that has been read.
Detailed Description¶
A BackBuffer instance is useful for reading the last part of a file in an efficient manner, when it is not known exactly how far back (towards the front!) to go, to find the start of the desired data block.
BackBuffer is a vector< unsigned char > that fills itself with data from a file by reading chunks from the end of the file progressing towards the start. Upon construction the BackBuffer instance is associated with a file and a chunksize can be specified. To read a chunk of the file into the BackBuffer call readChunk().
Definition at line 32 of file backbuffer.h.
Constructor & Destructor Documentation¶
zipios::BackBuffer::BackBuffer (istream & is, VirtualSeeker vs = VirtualSeeker(), int chunk_size = 1024) [inline], [explicit]¶
BackBuffer constructor.
Parameters:
chunk_size specifies the size of the chunks to read the file into the BackBuffer in.
Exceptions:
Definition at line 61 of file backbuffer.h.
Member Function Documentation¶
int zipios::BackBuffer::readChunk (int & read_pointer) [inline]¶
Reads another chunk and returns the size of the chunk that has been read. Returns 0 on I/O failure.
Parameters:
Definition at line 75 of file backbuffer.h.
Author¶
Generated automatically by Doxygen for Zipios++ from the source code.
Fri Aug 19 2016 | Zipios++ |