include/anna/comm/LiteTransport.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_LiteTransport_hpp
  38 #define anna_comm_LiteTransport_hpp
  39
  40 #include <anna/comm/Transport.hpp>
  41 #include <anna/comm/TransportFactory.hpp>
  42 #include <anna/comm/TransportFactoryImpl.hpp>
  43
  44 namespace anna {
  45
  46 namespace comm {
  47
  48 /**
  49    Este protocolo esta orientado a intercambiar mensajes en una red interna, por lo que supone
  50    que no van a existir errores en los mensajes recibidos y que los mensajes son suficientemente cortos
  51    como poder representar su longitud en dos nicos bytes.
  52
  53    Los supuestos bajo los que se dise este protocolo facilitan el desarrollo de clases que ofrecen un
  54    gran rendimiento, pero imposibilitan el desarrollo del sistema de re-sincronizacin en caso de que alguno
  55    de los mensajes no cumpla los supuestos. Es decir, si nos llega un mensaje errneo nuestro proceso no sera
  56    capaz de volver a sincronizarse nunca mas.
  57
  58    \warning Hay que tener en cuenta que el m�odo de codificacin no ofrece informacin
  59    suficiente para poder re-sincronizar los procesos en caso de error.
  60
  61    \see Transport.
  62 */
  63 class LiteTransport : public comm::Transport {
  64 public:
  65   static const int headerSize = sizeof(short int);  /**< Tamao de la cabezera del mensaje */
  66
  67   /**
  68      Destructor
  69   */
  70   ~LiteTransport();
  71
  72   /**
  73      Devuelve el literal que indentifica de esta clase.
  74      \return el literal que indentifica de esta clase.
  75   */
  76   static const char* className() throw() { return "anna::comm::LiteTransport"; }
  77
  78   /**
  79      Devuelve el gestor de capas de transporte asociado a esta clase.
  80      \return El gestor de capas de transporte asociado a esta clase.
  81   */
  82   static TransportFactory& getFactory() throw() { return st_transportFactory; }
  83
  84 private:
  85   static TransportFactoryImpl <LiteTransport> st_transportFactory;
  86
  87   LiteTransport();
  88
  89   int calculeSize(const DataBlock&) throw(RuntimeException);
  90   const Message* decode(const DataBlock&) throw(RuntimeException);
  91   const DataBlock& code(Message&) throw(RuntimeException);
  92
  93   friend class anna::Allocator <LiteTransport>;
  94 };
  95
  96 }
  97 }
  98 #endif
  99