include/anna/comm/TransportFactory.hpp

   1 // ANNA - Anna is Not Nothingness Anymore                                                         //
   2 //                                                                                                //
   3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
   4 //                                                                                                //
   5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
   6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
   7
   8
   9 #ifndef anna_comm_TransportFactory_hpp
  10 #define anna_comm_TransportFactory_hpp
  11
  12 #include <anna/core/RuntimeException.hpp>
  13 #include <anna/core/mt/NRMutex.hpp>
  14 #include <anna/core/functions.hpp>
  15
  16 namespace anna {
  17
  18 namespace xml {
  19 class Node;
  20 }
  21
  22 namespace comm {
  23
  24 class Transport;
  25 class ClientSocket;
  26
  27 /**
  28    Interfaz que deben cumplir los gestores de capas de transporte.
  29 */
  30 class TransportFactory : public NRMutex {
  31 public:
  32   /**
  33      Devuelve el nombre logico de esta factoria de capas de transporte.
  34      \return el nombre logico de esta factoria de capas de transporte.
  35   */
  36   const std::string& getName() const throw() { return a_name; }
  37
  38   /**
  39      Devuelve la longitud maxima  que puede contener el buffer intermedio antes de cerrar el socket
  40      por considerar que no puede sincronizarlo. Un valor 0 indica que no ha sido establecido
  41      ningun valor maximo, por lo que el valor a usar sera el indicado por
  42      anna::comm::Transport::DefaultMaxSize.
  43   */
  44   int getOverQuotaSize() const throw() { return a_overQuotaSize; }
  45
  46   /**
  47      Establece la longitud maxima que puede contener el buffer intermedio antes de cerrar el socket
  48      por considerar que no puede sincronizarlo.
  49      \param overQuotaSize longitud maxima que puede contener el buffer intermedio antes de cerrar el socket
  50      por considerar que no puede sincronizarlo.
  51   */
  52   void setOverQuotaSize(const int overQuotaSize) throw() { a_overQuotaSize = overQuotaSize; }
  53
  54   /**
  55      Devuelve una cadena con la informacion relevante sobre esta instancia.
  56      \return una cadena con la informacion relevante sobre esta instancia.
  57   */
  58   std::string asString() const throw();
  59
  60   /**
  61      Devuelve un documento XML con la informacion relevante sobre esta instancia.
  62      \param parent Nodo XML del que debe depender el documento generado.
  63      \return un documento XML con la informacion relevante sobre esta instancia.
  64   */
  65   xml::Node* asXML(xml::Node* parent) const throw();
  66
  67 protected:
  68   /**
  69      Constructor
  70      \param name Nombre logico de esta factoria de capas de transporte.
  71   */
  72   TransportFactory(const char* name) : a_name(name), a_overQuotaSize(0) {;}
  73
  74   /**
  75      Crea una instancia del protocolo de transporte asociado a esta factoria.
  76      \return La instancia de un nuevo protocolo de transporte.
  77      \warning Cada uno de los transportes obtenidos debera ser liberado invocando a #release.
  78   */
  79   virtual Transport* create() throw()  = 0;
  80
  81   /**
  82      Libera la instancia del transporte recibida como parametro.
  83      \param transport Instancia del protocolo de transporte a liberar.
  84      \warning El transporte recibido como parametro debera haberse obtenido mediante #create.
  85   */
  86   virtual void release(Transport* transport) throw()  = 0;
  87
  88 private:
  89   const std::string a_name;
  90   int a_overQuotaSize;
  91
  92   friend class ClientSocket;
  93 };
  94
  95 }
  96 }
  97
  98 #endif