Gzip Class Reference

Inheritance diagram for Gzip:

List of all members.

Public Member Functions
u_long	compress (const char *in, u_long sizeIn, char *out, u_long sizeOut)
virtual int	flush (u_long *)
u_long	flush (char *out, u_long sizeOut)
u_long	free ()
virtual int	getFooter (char *buffer, u_long len, u_long *nbw)
u_long	getFooter (char *str, int size)
virtual int	getHeader (char *buffer, u_long len, u_long *nbw)
u_long	getHeader (char *buffer, u_long buffersize)
virtual const char *	getName (char *name, u_long len)
	Gzip ()
u_long	initialize ()
virtual int	modifyData ()
virtual int	read (char *buffer, u_long len, u_long *)
u_long	updateCRC (char *buffer, int size)
virtual int	write (const char *buffer, u_long len, u_long *)
	~Gzip ()
Static Public Member Functions
Filter *	factory (const char *name)
u_long	footerSize ()
u_long	headerSize ()
Private Attributes
int	active
GzipData	data

---

Constructor & Destructor Documentation

Gzip::Gzip (   )

Constructor for the class.

Gzip::~Gzip (   )

Destructor for the class.

---

Member Function Documentation

u_long Gzip::compress (  const char *  in, u_long  sizeIn, char *  out, u_long  sizeOut )

Compress the in buffer to the out buffer using the gzip compression. Parameters: in  Buffer to compress. sizeIn  The dimension of the buffer to compress. out  Buffer where compress. sizeOut  The dimension of the buffer where compress.

Filter * Gzip::factory (  const char *  name  )  [static]

Returns a new Gzip object. Parameters: name  Filter name.

int Gzip::flush (  u_long *  nbw  )  [virtual]

Inherited from Filter. Parameters: nbw  Number of flushed bytes. Reimplemented from Filter.

u_long Gzip::flush (  char *  out, u_long  sizeOut )

Flush all the remaining data. Parameters: out  Buffer where write. sizeOut  Buffer length.

u_long Gzip::footerSize (   )  [static]

Get the GZIP footer size.

u_long Gzip::free (   )

Close the gzip compression.

int Gzip::getFooter (  char *  buffer, u_long  len, u_long *  nbw )  [virtual]

Inherited from Filter. Parameters: buffer  Buffer where write. len  Buffer length. nbw  Numbers of written bytes. Reimplemented from Filter.

u_long Gzip::getFooter (  char *  footer, int  size )

Get the GZIP footer. Parameters: footer  Buffer where write. size  Buffer length.

int Gzip::getHeader (  char *  buffer, u_long  len, u_long *  nbw )  [virtual]

From Filter Reimplemented from Filter.

u_long Gzip::getHeader (  char *  buffer, u_long  buffersize )

Copy the GZIP header in the buffer. Parameters: buffer  Buffer where write. buffersize  Buffer length.

const char * Gzip::getName (  char *  name, u_long  len )  [virtual]

Return a string with the filter name. If an external buffer is provided write the name there too. Parameters: name  Buffer where write the filter name. len  Buffer size. Reimplemented from Filter.

u_long Gzip::headerSize (   )  [static]

Get the GZIP header size.

u_long Gzip::initialize (   )

Initialize the gzip structure value.

int Gzip::modifyData (   )  [virtual]

The Gzip filter modifies the data. Reimplemented from Filter.

int Gzip::read (  char *  buffer, u_long  len, u_long *  nbr )  [virtual]

Inherited from Filter. This function uses an internal buffer slowing it. It is better to use directly the Gzip::compress routine where possible. Parameters: buffer  Buffer where write. len  Buffer length. nbr  Number of read bytes. Reimplemented from Filter.

u_long Gzip::updateCRC (  char *  buffer, int  size )

Update the existent CRC. Parameters: buffer  Buffer to look. size  Number of bytes to look.

int Gzip::write (  const char *  buffer, u_long  len, u_long *  nbw )  [virtual]

Inherited from Filter. Parameters: buffer  Buffer where write. len  Buffer length. nbw  Number of written bytes. Reimplemented from Filter.

---

Member Data Documentation

int Gzip::active [private]

GzipData Gzip::data [private]

---