Atlas_Filter man page

Atlas::Filter — Atlas stream filter.

Synopsis

#include <Filter.h>

Inherited by Atlas::Filters::Bzip2, and Atlas::Filters::Gzip.

Public Types

enum Type { CHECKSUM, COMPRESSION, ENCRYPTION }

Public Member Functions

Filter (Filter *=0)

virtual void begin ()=0

virtual void end ()=0

virtual std::string encode (const std::string &)=0

virtual std::string decode (const std::string &)=0

Protected Attributes

Filter * m_next

Detailed Description

Atlas stream filter.

Filters are used by Codec to transform the byte stream before transmission. The transform must be invertible; that is to say, encoding a string and then decoding it must result in the original string. Filters can be used for compression, encryption or performing checksums and other forms of transmission error detection. A compound filter can be created that acts like a single filter, allowing various filters to be chained together in useful ways such as compressing and then encrypting.

See also:

Codec

Negotiate

Author

Generated automatically by Doxygen for Atlas-C++ from the source code.

Info

Wed Feb 3 2016 Atlas-C++