zipios_backbuffer(3) [debian man page]

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, VirtualSeekervs = VirtualSeeker(), intchunk_size = 1024) [inline, explicit]
       BackBuffer constructor. Parameters:
	   is The istream to read the data from. The stream must be seekable, as BackBuffer will reposition the file position to read chunks from
	   the back of the file.
	   chunk_size specifies the size of the chunks to read the file into the BackBuffer in.

       Exceptions:
	   FCollException Thrown if the VirtualSeeker vs that has been specified is invalid for the istream is.

       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:
	   read_pointer When a new chunk is read in the already stored bytes change position in the BackBuffer. read_pointer is assumed by
	   readChunk() to be a pointer into a position in the BackBuffer, and is updated to point to the same position in the file as it pointed
	   to before the new chunk was read.

       Definition at line 75 of file backbuffer.h.

Author
       Generated automatically by Doxygen for Zipios++ from the source code.

Zipios++							  Mon Oct 10 2011					     zipios::BackBuffer(3)

Check Out this Related Man Page

zipios::ZipInputStream(3)				     Library Functions Manual					 zipios::ZipInputStream(3)

NAME

       zipios::ZipInputStream -

SYNOPSIS

       #include <zipinputstream.h>

       Inherits istream.

   Public Member Functions
       ZipInputStream (istream &is, streampos pos=0)
	   ZipInputStream constructor.
       ZipInputStream (const string &filename, streampos pos=0)
	   ZipInputStream constructor.
       int available ()
       void closeEntry ()
	   Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if there is one).
       void close ()
	   Closes the istream.
       ConstEntryPointer getNextEntry ()
       virtual ~ZipInputStream ()
	   Destructor.

Detailed Description
	ZipInputStream is an istream that gets it's input from a zip file. The interface approximates the interface of the Java ZipInputStream.

       Definition at line 20 of file zipinputstream.h.

Constructor &; Destructor Documentation
   zipios::ZipInputStream::ZipInputStream (istream &is, streampospos = 0) [explicit]
       ZipInputStream constructor. Parameters:
	   is istream from which the compressed zip archive can be read.
	   pos position to reposition the istream to before reading.

   zipios::ZipInputStream::ZipInputStream (const string &filename, streampospos = 0) [explicit]
       ZipInputStream constructor. filename of a valid zip file.

       Parameters:
	   pos position to reposition the istream to before reading.

   zipios::ZipInputStream::~ZipInputStream () [virtual]
       Destructor.

       Definition at line 53 of file zipinputstream.cpp.

Member Function Documentation
   void zipios::ZipInputStream::close ()
       Closes the istream.

       Definition at line 41 of file zipinputstream.cpp.

   void zipios::ZipInputStream::closeEntry ()
       Closes the current entry, and positions the stream read pointer at the beginning of the next entry (if there is one).

       Definition at line 37 of file zipinputstream.cpp.

   ConstEntryPointer zipios::ZipInputStream::getNextEntry () Opens the next entry in the zip archive and returns a const pointer to a FileEntry
       object for the entry. For new instances this method has to be called once before you can read from the first entry.
       Returns:
	   a const FileEntry * containing information about the (now) current entry.

       Definition at line 48 of file zipinputstream.cpp.

Author
       Generated automatically by Doxygen for Zipios++ from the source code.

Zipios++							  Mon Oct 10 2011					 zipios::ZipInputStream(3)

Linux and UNIX Man Pages

zipios_backbuffer(3) [debian man page]

Check Out this Related Man Page