include/anna/diameter.comm/Transport.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_diameter_comm_Transport_hpp
  38 #define anna_diameter_comm_Transport_hpp
  39
  40
  41 #include <anna/config/defines.hpp>
  42 #include <anna/core/RuntimeException.hpp>
  43 #include <anna/comm/Transport.hpp>
  44 #include <anna/comm/TransportFactoryImpl.hpp>
  45
  46 namespace anna {
  47 class DataBlock;
  48 }
  49
  50
  51
  52 namespace anna {
  53
  54 namespace diameter {
  55
  56 namespace comm {
  57
  58
  59 /**
  60    Clase generica para definir la capa de transporte del protocolo de comunicaciones diameter.
  61
  62    Este protocolo esta orientado a intercambiar mensajes en una red interna, por lo que supone
  63    que no van a existir errores en los mensajes recibidos y que los mensajes son suficientemente cortos
  64    como para ocupar un unico paquete, por lo que no tiene ningun tipo de etiqueta especial que nos informe
  65    sobre el inicio y/o fin del mensaje.
  66
  67    Los supuestos bajo los que se dise este protocolo facilitan el desarrollo de clases que ofrecen un
  68    gran rendimiento, pero imposibilitan el desarrollo del sistema de re-sincronizacin en caso de que alguno
  69    de los mensajes no cumpla los supuestos. Es decir, si nos llega un mensaje errneo nuestro proceso no sera
  70    capaz de volver a sincronizarse nunca mas, por lo que el sistema de proteccion integrado en anna.comm
  71    terminara cerrando la conexion.
  72 */
  73 class Transport : public anna::comm::Transport {
  74 public:
  75   /**
  76      Destructor
  77   */
  78   ~Transport();
  79
  80   /**
  81      Devuelve el gestor de capas de transporte asociado a esta clase.
  82      \return El gestor de capas de transporte asociado a esta clase.
  83   */
  84   static anna::comm::TransportFactory& getFactory() throw() { return st_factory; }
  85
  86   /**
  87      Devuelve el literal que identifica de esta clase.
  88      \return el literal que identifica de esta clase.
  89   */
  90   static const char* className() throw() { return "diameter::comm::Transport"; }
  91
  92 private:
  93   static anna::comm::TransportFactoryImpl <anna::diameter::comm::Transport> st_factory;
  94
  95   Transport();
  96
  97   int calculeSize(const anna::DataBlock&) throw(anna::RuntimeException);
  98   const anna::comm::Message* decode(const anna::DataBlock&) throw(anna::RuntimeException);
  99   const anna::DataBlock& code(anna::comm::Message&) throw(anna::RuntimeException);
 100
 101   friend class anna::Allocator <anna::diameter::comm::Transport>;
 102 };
 103
 104 }
 105 }
 106 }
 107
 108 #endif
 109