include/anna/comm/Buffer.hpp

   1 // ANNA - Anna is Not Nothingness 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_comm_Buffer_hpp
  38 #define anna_comm_Buffer_hpp
  39
  40 #include <anna/core/DataBlock.hpp>
  41
  42 namespace anna {
  43
  44 namespace comm {
  45
  46 /**
  47    Clase para mantener en memoria lo buffer intermedios usados para enviar y/o recibir
  48    mensajes,
  49 */
  50 class Buffer : public DataBlock {
  51 public:
  52   /**
  53      Constructor.
  54   */
  55   Buffer() : DataBlock(false) {;}
  56
  57   /**
  58      Establece la direccion de memoria asociada a esta memoria intermedia.
  59      \param buffer Direccion de memoria asociada a esta instancia.
  60      \param size Numero de bytes asociados a esta instancia.
  61   */
  62   void setup(const char* buffer, const int size) throw() {
  63     setBuffer(buffer);
  64     setSize(size);
  65   }
  66
  67   /**
  68      Establece la longitud de la memoria asociada a esta instancia.
  69      \param size Numero de bytes asociados a esta instancia.
  70   */
  71   void resize(const int size) throw() { setSize(size); }
  72 };
  73
  74 }
  75 }
  76
  77 #endif