Atlas-C++
Public Types | Public Member Functions | Protected Attributes | List of all members
Atlas::Filter Class Referenceabstract

Atlas stream filter. More...

#include <Filter.h>

Inheritance diagram for Atlas::Filter:
Atlas::Filters::Bzip2 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

Filterm_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

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

Copyright 2000-2004 the respective authors.

This document can be licensed under the terms of the GNU Free Documentation License or the GNU General Public License and may be freely distributed under the terms given by one of these licenses.