include/anna/comm/Codec.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_comm_Codec_hpp
  38 #define anna_comm_Codec_hpp
  39
  40 #include <anna/comm/CompatCodec.hpp>
  41
  42 namespace anna {
  43
  44 class Second;
  45 class Millisecond;
  46 class Microsecond;
  47 namespace comm {
  48
  49 /**
  50    Codificador/Decodificador compatible para transporte de datos
  51
  52    Esta clase ofrece una forma muy eficaz para codificar estructuras de datos complejas y pretende
  53    sustituir los tipicos aplanadores y desaplanadores ya que permite que cualquier proceso
  54    defina facilmente la forma de transferir cierta informacion sobre un bloque de memoria
  55    y viceversa.
  56
  57    Vamos a ver un ejemplo de uso. Primero vamos a definir la clase MensajeDemo:
  58
  59 * \code
  60 *
  61 * #include <anna.comm.Codec.h>
  62 *
  63 * class MensajeDemo : public Codec {
  64 * public:
  65 *    static const Codec::Type type = 10;
  66 *
  67 *    MensajeDemo () : Codec (type),
  68 *       a_dataBlock (true)
  69 *    {
  70 *       attach ("Entero", a_entero);
  71 *       attach ("Cadena",  a_cadena);
  72 *       attach ("Bloque datos",  a_dataBlock);
  73 *    }
  74 *
  75 *    // Accesores
  76 *    const int obtenerEntero () const { return a_entero; }
  77 *    const std::string& obtenerCadena () const { return a_cadena; }
  78 *    const DataBlock& obtenerDataBlock () const { return a_dataBlock; }
  79 *
  80 *    // Modificadores
  81 *    void establecerEntero (const int entero) { a_entero = entero; }
  82 *    void establecerCadena (const std::string& cadena) { a_cadena = cadena; }
  83 *    void establecerCadena (const char* cadena) { a_cadena = cadena; }
  84 *    void establecerDataBlock (const DataBlock& dataBlock) { a_dataBlock = dataBlock; }
  85 *
  86 * private:
  87 *    int a_entero;
  88 *    std::string a_cadena;
  89 *    DataBlock a_dataBlock;
  90 * };
  91 *
  92 * \endcode
  93 *
  94    La clase que use esta clase para enviar un mensaje debe establecer los valores de cada uno de
  95    los datos mediante los modificadores definidos y luego invocar al metodo #code que
  96    transferiria el contenido de las variables asociadas a este mensaje a un bloque de memoria,
  97    que normalmente seriausado como mensaje.
  98
  99    Por otra parte la clase que recibe el mensaje invocar�al metodo #decode que transfiere
 100    el contenido del bloque de memoria a cada una de las variables asociadas al mensaje.
 101    Posteriormente, podremos acceder al contenido de cada una de las variables asociadas al
 102    mensaje atraves de los accesores definidos para el caso.
 103
 104    Estos codificadores nos dan la posibilidad de definir variables opcionales, de forma que
 105    una determinada variable puede no ser transferida al bloque de memoria, y por tanto puede
 106    no ser recibida en el otro extremo. Ver el metodo #isNull y #setNull para mas informacion.
 107
 108    \warning Esta clase no establece proteccion ante accesos concurrentes
 109 */
 110 class Codec : public CompatCodec {
 111 public:
 112   /**
 113      Constructor.
 114
 115      @param type Tipo por el que sera conocido este tipo de mensaje.
 116      @param scramble Indica si el mensaje debe ser codificado de forma que no se pueda ver el contenido
 117      del mismo con una simple herramienta de monitorizacion de mensajes de red. Por defecto esta
 118      activo ya que la codificacion realizada es muy simple y rapida y el tiempo empleado es casi
 119      inapreciable.
 120   */
 121   explicit Codec(const Type type, const bool scramble = true) : CompatCodec(type, scramble) {;}
 122
 123   /**
 124      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 125      estapensada principalmente para comunicar entre si procesos remotos
 126      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 127      de ellos le da a un determinado `id'.
 128
 129      \param name Nombre logico de la variable
 130      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 131      al mensaje y viceversa.
 132      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 133   */
 134   const Variable* attach(const char* name, std::string& value) throw(RuntimeException) { return CompatCodec::attach(name, size(), value); }
 135
 136   /**
 137      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 138      estapensada principalmente para comunicar entre si procesos remotos
 139      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 140      de ellos le da a un determinado `id'.
 141
 142      \param name Nombre logico de la variable
 143      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 144      al mensaje y viceversa.
 145      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 146   */
 147   const Variable* attach(const char* name, const char*& value) throw(RuntimeException) { return CompatCodec::attach(name, size(), value); }
 148
 149   /**
 150      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 151      estapensada principalmente para comunicar entre si procesos remotos.
 152      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 153      de ellos le da a un determinado `id'.
 154
 155      \param name Nombre logico de la variable
 156      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 157      al mensaje y viceversa.
 158      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 159   */
 160   const Variable* attach(const char* name, int& value) throw(RuntimeException) { return CompatCodec::attach(name, size(), value); }
 161
 162   /**
 163      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 164      estapensada principalmente para comunicar entre si procesos remotos.
 165      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 166      de ellos le da a un determinado `id'.
 167
 168      \param name Nombre logico de la variable
 169      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 170      al mensaje y viceversa.
 171      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 172   */
 173   const Variable* attach(const char* name, Integer64& value) throw(RuntimeException) { return CompatCodec::attach(name, size(), value); }
 174
 175   /**
 176      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 177      estapensada principalmente para comunicar entre si procesos remotos.
 178      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 179      de ellos le da a un determinado `id'.
 180
 181      \param name Nombre logico de la variable
 182      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 183      al mensaje y viceversa.
 184      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 185   */
 186   const Variable* attach(const char* name, bool& value) throw(RuntimeException) { return CompatCodec::attach(name, size(), value); }
 187
 188   /**
 189      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 190      estapensada principalmente para comunicar entre si procesos remotos.
 191      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 192      de ellos le da a un determinado `id'.
 193
 194      \param name Nombre logico de la variable
 195      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 196      al mensaje y viceversa. Debe tener activado el sistema de copia profunda.
 197      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 198   */
 199   const Variable* attach(const char* name, DataBlock& value) throw(RuntimeException) { return CompatCodec::attach(name, size(), value); }
 200
 201   /**
 202      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 203      estapensada principalmente para comunicar entre si procesos remotos.
 204      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 205      de ellos le da a un determinado `id'.
 206
 207      \param name Nombre logico de la variable
 208      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 209      al mensaje y viceversa. Debe tener activado el sistema de copia profunda.
 210      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 211   */
 212   const Variable* attach(const char* name, float& value) throw(RuntimeException) { return CompatCodec::attach(name, size(), value); }
 213
 214   /**
 215      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 216      estapensada principalmente para comunicar entre si procesos remotos.
 217      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 218      de ellos le da a un determinado `id'.
 219
 220      \param name Nombre logico de la variable
 221      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 222      al mensaje y viceversa. Debe tener activado el sistema de copia profunda.
 223      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 224   */
 225   const Variable* attach(const char* name, double& value) throw(RuntimeException) { return CompatCodec::attach(name, size(), value); }
 226
 227   /**
 228      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 229      estapensada principalmente para comunicar entre si procesos remotos.
 230      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 231      de ellos le da a un determinado `id'.
 232
 233      \param name Nombre logico de la variable
 234      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 235      al mensaje y viceversa. Debe tener activado el sistema de copia profunda.
 236      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 237   */
 238   const Variable* attach(const char* name, Second& value) throw(RuntimeException);
 239
 240   /**
 241      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 242      estapensada principalmente para comunicar entre si procesos remotos.
 243      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 244      de ellos le da a un determinado `id'.
 245
 246      \param name Nombre logico de la variable
 247      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 248      al mensaje y viceversa. Debe tener activado el sistema de copia profunda.
 249      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 250   */
 251   const Variable* attach(const char* name, Millisecond& value) throw(RuntimeException);
 252
 253   /**
 254      Asocia el valor recibido como parametro al dato interno identificado por `id'. Esta clase
 255      estapensada principalmente para comunicar entre si procesos remotos
 256      La unica restriccion que se les imponen a ambos que es compartan el significado que cada uno
 257      de ellos le da a un determinado `id'.
 258
 259      \param name Nombre logico de la variable
 260      @param value Rerencia a una variable de nuestro entorno usada para transferir los datos de la memoria
 261      al mensaje y viceversa. Debe tener activado el sistema de copia profunda.
 262      @return Un puntero que hace referencia al nuevo dato interno que ha sido creado.
 263   */
 264   const Variable* attach(const char* name, Microsecond& value) throw(RuntimeException);
 265 };
 266
 267 }
 268 }
 269
 270 #endif