GzipDeflateTransformation.h

Go to the documentation of this file.

/*
 * Copyright (c) 2013 LinkedIn Corp. All rights reserved.
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of the license at
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the
 * License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
 * either express or implied.
 *
 */

/**
 * @file GzipDeflateTransformation.h
 * @author Brian Geffon
 * @author Manjesh Nilange
 * @brief Gzip Deflate Transformation can be used to compress content.
 */

#pragma once
#ifndef ATSCPPAPI_GZIPDEFLATETRANSFORMATION_H_
#define ATSCPPAPI_GZIPDEFLATETRANSFORMATION_H_

#include <string>
#include "atscppapi/TransformationPlugin.h"

namespace atscppapi {

namespace transformations {

/**
 * Internal state for Deflate Transformations
 * @private
 */
class GzipDeflateTransformationState;

/**
 * @brief 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.
 *
 * @see GzipInflateTransformation
 */
class GzipDeflateTransformation : public TransformationPlugin {
public:
  /**
   * A full example of how to use GzipDeflateTransformation and GzipInflateTransformation is available
   * in examples/gzip_tranformation/
   *
   * @param transaction As with any TransformationPlugin you must pass in the transaction
   * @param type because the GzipDeflateTransformation can be used with both requests and responses
   *  you must specify the Type.
   *
   * @see TransformationPlugin::Type
   */
  GzipDeflateTransformation(Transaction &transaction, TransformationPlugin::Type type);

  /**
   * Any TransformationPlugin must implement consume(), this method will take content
   * from the transformation chain and gzip compress it.
   *
   * @param data the input data to compress
   */
  void consume(const std::string &data);

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

  virtual ~GzipDeflateTransformation();
private:
  GzipDeflateTransformationState *state_; /** Internal state for Gzip Deflate Transformations */
};

}

}


#endif /* ATSCPPAPI_GZIPDEFLATETRANSFORMATION_H_ */