The GZipCodec class is a VirtualFile that transparently encodes and decodes a stream of data using the GZip compression algorithm. More...

#include <GZipCodec.hpp>

Inheritance diagram for vl::GZipCodec:

List of all members.

Public Member Functions
	GZipCodec (VirtualFile *stream=NULL)
	Constructor.
	GZipCodec (const String &gz_path)
	Constructor.
	~GZipCodec ()
	Destructor.
virtual bool	open (EOpenMode mode)
	Opens a compressed stream.
virtual bool	isOpen () const
	Returns true if the file is open for read or writing.
virtual bool	exists () const
	Returns true if the input or output stream file exists.
virtual void	close ()
	Closes the GZipStream.
virtual long long	size () const
	Returns the uncompressed size of the stream. This is not a thread safe function.
virtual ref< VirtualFile >	clone () const
	Returns an equivalent GZipCodec.
GZipCodec &	operator= (const GZipCodec &other)
void	setCompressionLevel (int level)
	Sets the compression level used during write operations.
int	compressionLevel () const
void	setStream (VirtualFile *stream)
	Installs the VirtualFile representing the GZip file to be read or to be written.
const VirtualFile *	stream () const
	Returns the VirtualFile representing the GZip file to be read or to be written.
VirtualFile *	stream ()
	Returns the VirtualFile representing the GZip file to be read or to be written.
long long	uncompressedSize ()
	Returns the uncompressed size of the stream.
long long	compressedSize () const
	Returns the size of the compressed stream as returned by `stream()->size()`.
float	compressionRatio () const
	Returns the compression ratio computed as `compressedsize/uncompressedsize`.
bool	warnOnSeek () const
void	setWarnOnSeek (bool warn_on)
Protected Types
enum	{ ZNone, ZCompress, ZDecompress }
Protected Member Functions
virtual long long	read_Implementation (void *buffer, long long bytes_to_read)
virtual long long	write_Implementation (const void *buffer, long long byte_count)
virtual long long	position_Implementation () const
void	resetStream ()
bool	seekSet_Implementation (long long pos)
bool	fillUncompressedBuffer ()
Protected Attributes
int	mCompressionLevel
ref< VirtualFile >	mStream
long long	mReadBytes
long long	mWrittenBytes
bool	mWarnOnSeek
z_stream_s *	mZStream
unsigned char	mZipBufferIn [CHUNK_SIZE]
unsigned char	mZipBufferOut [CHUNK_SIZE]
std::vector< char >	mUncompressedBuffer
int	mUncompressedBufferPtr
long long	mStreamSize
long long	mUncompressedSize
enum vl::GZipCodec:: { ... }	mMode

Detailed Description

The GZipCodec class is a VirtualFile that transparently encodes and decodes a stream of data using the GZip compression algorithm.

Definition at line 43 of file GZipCodec.hpp.

Member Enumeration Documentation

anonymous enum [protected]

Enumerator:

ZNone
ZCompress
ZDecompress

Definition at line 135 of file GZipCodec.hpp.

Constructor & Destructor Documentation

GZipCodec::GZipCodec ( VirtualFile * stream = NULL )

Constructor.

Definition at line 43 of file GZipCodec.cpp.

References mCompressionLevel, mReadBytes, mUncompressedSize, mWarnOnSeek, mWrittenBytes, and mZStream.

Referenced by clone().

GZipCodec::GZipCodec ( const String & gz_path )

Constructor.

Definition at line 54 of file GZipCodec.cpp.

References mCompressionLevel, mReadBytes, mUncompressedSize, mWarnOnSeek, mWrittenBytes, mZStream, and vl::VirtualFile::setPath().

GZipCodec::~GZipCodec ( )

Destructor.

Definition at line 66 of file GZipCodec.cpp.

References close(), mUncompressedSize, mWrittenBytes, mZStream, and NULL.

Member Function Documentation

bool GZipCodec::open ( EOpenMode mode ) [virtual]

Opens a compressed stream.

If mode == OM_ReadOnly the stream will be decompressed during read operations.
If mode == OM_WriteOnly the stream will be compressed during write operations.

Implements vl::VirtualFile.

Definition at line 74 of file GZipCodec.cpp.

References compressionLevel(), vl::Log::error(), vl::ref< T >::get(), isOpen(), vl::locateFile(), mMode, mReadBytes, mStreamSize, mUncompressedBuffer, mUncompressedBufferPtr, mWrittenBytes, mZStream, vl::OM_ReadOnly, vl::OM_WriteOnly, vl::VirtualFile::path(), setStream(), vl::VirtualFile::size(), stream(), ZCompress, ZDecompress, and ZNone.