include/anna/core/util/ZBlock.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_core_util_ZBlock_hpp
  38 #define anna_core_util_ZBlock_hpp
  39
  40 #include <anna/core//DataBlock.hpp>
  41
  42 namespace anna {
  43
  44 /**
  45    Facilita la compresión y descompresión de bloques de datos.
  46
  47    Para más información: \see http://zlib.net/manual.html
  48
  49    Para optimizar el acceso no se ha establecido ningun tipo de proteccion para ejecucion MT.
  50 */
  51 class ZBlock : public DataBlock {
  52 public:
  53   /**
  54    * Nivel de compresión que pueden ser aplicados.
  55    */
  56   struct Mode { enum _v { Default = -1, NoCompression, BestSpeed = 1, BestCompression = 9 }; };
  57
  58   /**
  59    * Constructor vacio.
  60    */
  61   ZBlock() : DataBlock(true) {;}
  62
  63   /**
  64    * Comprime el contenido del bloque de datos recibido como parámetro y lo guarda
  65    * en la estructura interna.
  66    * \param data Bloque de datos a comprimir.
  67    * \param mode Modo de compresión realizado.
  68    * \return El bloque de datos una vez comprimido y con la información suficiente para ser descomprimido.
  69    */
  70   const DataBlock& compress(const DataBlock& data, const Mode::_v mode = Mode::Default) throw(RuntimeException);
  71
  72   /**
  73    * Descomprime el bloque de datos recibido como parámetro.
  74    * \param zdata Bloque de datos obtenido como resultado de aplicar con ZBlock::compress.
  75    * \param originalSize Tamaño original que tenía el buffer antes de ser comprimido.
  76    * \return El bloque de datos descomprimdo.
  77    */
  78   const DataBlock& uncompress(const DataBlock& zdata) throw(RuntimeException);
  79
  80 private:
  81   ZBlock(const ZBlock&);
  82 };
  83
  84 }
  85
  86 #endif
  87
  88