Public Member Functions

atscppapi::transformations::GzipInflateTransformation Class Reference

A TransformationPlugin to easily add gzip inflate to your TransformationPlugin chain. More...

#include <GzipInflateTransformation.h>

Inherits atscppapi::TransformationPlugin.

Collaboration diagram for atscppapi::transformations::GzipInflateTransformation:
Collaboration graph
[legend]

Public Member Functions

 GzipInflateTransformation (Transaction &transaction, TransformationPlugin::Type type)
 A full example of how to use GzipInflateTransformation and GzipDeflateTransformation is available in examples/gzip_tranformation/.
void consume (const std::string &)
 Any TransformationPlugin must implement consume(), this method will take content from the transformation chain and gzip decompress it.
void handleInputComplete ()
 Any TransformationPlugin must implement handleInputComplete(), this method will finalize the gzip decompression.
virtual ~GzipInflateTransformation ()

Detailed Description

A TransformationPlugin to easily add gzip inflate to your TransformationPlugin chain.

The GzipInflateTransformation is a helper transformation that can be used to easily decompress gzipped content. For a full example of GzipInflateTransformation and GzipDeflateTransformation see examples/gzip_transformation/.

Note:
GzipDeflateTransformation DOES NOT set or check Content-Encoding headers, it is the users responsibility to set any applicable headers and check that the content is acctually gzipped by checking the Content-Encoding header before creating a GzipInflateTransformation, see examples/gzip_transformation/ for a full example.
See also:
GzipDeflateTransformation

Definition at line 55 of file GzipInflateTransformation.h.


Constructor & Destructor Documentation

atscppapi::transformations::GzipInflateTransformation::GzipInflateTransformation ( Transaction transaction,
TransformationPlugin::Type  type 
)

A full example of how to use GzipInflateTransformation and GzipDeflateTransformation is available in examples/gzip_tranformation/.

Parameters:
transaction As with any TransformationPlugin you must pass in the transaction
type because the GzipInflateTransformation can be used with both requests and responses you must specify the Type.
See also:
TransformationPlugin::Type
virtual atscppapi::transformations::GzipInflateTransformation::~GzipInflateTransformation (  )  [virtual]

Member Function Documentation

void atscppapi::transformations::GzipInflateTransformation::consume ( const std::string &   )  [virtual]

Any TransformationPlugin must implement consume(), this method will take content from the transformation chain and gzip decompress it.

Parameters:
data the input data to decompress

Implements atscppapi::TransformationPlugin.

void atscppapi::transformations::GzipInflateTransformation::handleInputComplete (  )  [virtual]

Any TransformationPlugin must implement handleInputComplete(), this method will finalize the gzip decompression.

Implements atscppapi::TransformationPlugin.


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