BlockCompressionCodec.h

Go to the documentation of this file.

/* -*- c++ -*-
 * Copyright (C) 2007-2015 Hypertable, Inc.
 *
 * This file is part of Hypertable.
 *
 * Hypertable is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; version 3 of the
 * License, or any later version.
 *
 * Hypertable is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */


#ifndef Hypertable_Lib_BlockCompressionCodec_h
#define Hypertable_Lib_BlockCompressionCodec_h

#include <Common/Error.h>
#include <Common/String.h>

#include <Hypertable/Lib/BlockHeader.h>

#include <cassert>
#include <memory>
#include <vector>

namespace Hypertable {

  class DynamicBuffer;


  class BlockCompressionCodec {
  public:

    enum Type {
      UNKNOWN=-1, 
      NONE=0,     
      BMZ=1,      
      ZLIB=2,     
      LZO=3,      
      QUICKLZ=4,  
      SNAPPY=5,   
      COMPRESSION_TYPE_LIMIT=6  
    };

    typedef std::vector<String> Args;

    static const char *get_compressor_name(uint16_t algo);

    virtual ~BlockCompressionCodec() { }

    virtual void deflate(const DynamicBuffer &input, DynamicBuffer &output,
                         BlockHeader &header, size_t reserve=0) = 0;

    virtual void inflate(const DynamicBuffer &input, DynamicBuffer &output,
                         BlockHeader &header) = 0;

    virtual void set_args(const Args &args) {
      for (const auto &arg : args)
        HT_THROWF(Error::BLOCK_COMPRESSOR_INVALID_ARG, "Unrecognized argument "
                  "to %s codec: '%s'", get_compressor_name(get_type()),
                  arg.c_str());
    }

    virtual int get_type() = 0;

  };

  typedef std::shared_ptr<BlockCompressionCodec> BlockCompressionCodecPtr;


}

#endif // Hypertable_Lib_BlockCompressionCodec_h