CompressionBase Class Reference

This is an abstract base class for stream compression implementations. More...

#include <compressionbase.h>

Inherited by CompressionZlib.

Inheritance diagram for CompressionBase:

[legend]List of all members.

Public Member Functions
	CompressionBase (CompressionDataHandler *cdh)
virtual	~CompressionBase ()
virtual bool	init ()=0
virtual void	compress (const std::string &data)=0
virtual void	decompress (const std::string &data)=0

---

Detailed Description

This is an abstract base class for stream compression implementations.

You should not need to use this class directly.

Author:

Jakob Schroeter <js@camaya.net>

Since:

0.9

Definition at line 34 of file compressionbase.h.

---

Constructor & Destructor Documentation

CompressionBase (  CompressionDataHandler *  cdh  )  [inline]

Contructor. Parameters: cdh  A CompressionDataHandler-derived object that will be notified about finished de/compression. Definition at line 42 of file compressionbase.h.

virtual ~CompressionBase (   )  [inline, virtual]

Virtual Destructor. Definition at line 47 of file compressionbase.h.

---

Member Function Documentation

virtual void compress (  const std::string &  data  )  [pure virtual]

Compresses the given chunk of data. Parameters: data  The original (uncompressed) data. Implemented in CompressionZlib.

virtual void decompress (  const std::string &  data  )  [pure virtual]

Decompresses the given chunk of data. Parameters: data  The compressed data. Implemented in CompressionZlib.

virtual bool init (   )  [pure virtual]

This function initializes the compression module. it is mandatory to be called. Returns: True if the module was initialized successfully, false otherwise. Implemented in CompressionZlib.

---

The documentation for this class was generated from the following file:

• compressionbase.h

---