Inheritance diagram for atscppapi::transformations::GzipDeflateTransformation:

Public Member Functions
	GzipDeflateTransformation (Transaction &transaction, TransformationPlugin::Type type)

void	consume (const std::string &data)

void	handleInputComplete ()

Public Member Functions inherited from atscppapi::TransformationPlugin
virtual	~TransformationPlugin ()

Public Member Functions inherited from atscppapi::TransactionPlugin
void	registerHook (Plugin::HookType hook_type)

Public Member Functions inherited from atscppapi::Plugin
virtual void	handleReadRequestHeadersPreRemap (Transaction &transaction)

virtual void	handleReadRequestHeadersPostRemap (Transaction &transaction)

virtual void	handleSendRequestHeaders (Transaction &transaction)

virtual void	handleReadResponseHeaders (Transaction &transaction)

virtual void	handleSendResponseHeaders (Transaction &transaction)

virtual void	handleOsDns (Transaction &transaction)

Additional Inherited Members
Public Types inherited from atscppapi::TransformationPlugin
enum	Type { REQUEST_TRANSFORMATION = 0, RESPONSE_TRANSFORMATION }

Protected Member Functions inherited from atscppapi::TransformationPlugin
size_t	produce (const std::string &)

size_t	setOutputComplete ()

	TransformationPlugin (Transaction &transaction, Type type)

Detailed Description

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

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

Note: GzipDeflateTransformation DOES NOT set Content-Encoding headers, it is the users responsibility to set any applicable headers.

Constructor & Destructor Documentation

GzipDeflateTransformation::GzipDeflateTransformation	(	Transaction &	transaction,
		TransformationPlugin::Type	type
	)

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

Parameters

transaction	As with any TransformationPlugin you must pass in the transaction
type	because the GzipDeflateTransformation can be used with both requests and responses you must specify the Type.

void GzipDeflateTransformation::consume ( const std::string & data )

virtual

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

Parameters

data	the input data to compress

void GzipDeflateTransformation::handleInputComplete ( )

virtual

Any TransformationPlugin must implement handleInputComplete(), this method will finalize the gzip compression and flush any remaining data and the epilouge.

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