include/anna/comm/internal/LocalConnection.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_internal_LocalConnection_hpp
  38 #define anna_comm_internal_LocalConnection_hpp
  39
  40 namespace anna {
  41
  42 namespace xml {
  43 class Node;
  44 }
  45
  46 namespace comm {
  47
  48 class ServerSocket;
  49 class ClientSocket;
  50
  51 namespace handler {
  52 class ServerSocket;
  53 }
  54
  55 /**
  56    Implementa los socket locales, es decir, conexiones aceptadas por los ServerSocket que
  57    estan activos en nuestra aplicacion.
  58 */
  59 class LocalConnection {
  60 public:
  61   /**
  62      Constructor.
  63   */
  64   LocalConnection() : a_serverSocket(NULL), a_clientSocket(NULL) {;}
  65
  66   /**
  67      Devuelve el servidor de socket a partir del cual se cre este socket cliente.Puede ser NULL si este
  68      socket cliente no est�asociado a ningn servidor de sockets.
  69      \return El servidor de socket a partir del cual se cre este socket cliente.
  70   */
  71   ServerSocket* getServerSocket() const throw() { return a_serverSocket; }
  72
  73   /**
  74      Devuelve el socket cliente  asociado a esta conexion. Puede ser NULL si la conexion no ha sido establecida.
  75      \return El socket cliente asociado a esta conexion.
  76   */
  77   ClientSocket* getClientSocket() throw() { return a_clientSocket; }
  78
  79   /**
  80      Devuelve una cadena con la informacin referente a este socket.
  81      \return Una cadena con la informacin referente a este socket.
  82   */
  83   std::string asString() const throw();
  84
  85   /**
  86      Devuelve un nodo XML con la informacin referente a este objeto.
  87      \param parent Nodo XML a partir del cual introducir la informacin.
  88      \return Un nodo XML con la informacin referente a este objeto.
  89   */
  90   xml::Node* asXML(xml::Node* parent) const throw(RuntimeException);
  91
  92   /**
  93      Devuelve el nombre logico de esta clase.
  94      \return el nombre logico de esta clase.
  95   */
  96   static const char* className() throw() { return "anna::comm::LocalConnection"; }
  97
  98 private:
  99   ServerSocket* a_serverSocket;
 100   ClientSocket* a_clientSocket;
 101
 102   void setServerSocket(ServerSocket* serverSocket) throw() { a_serverSocket = serverSocket; }
 103   void setClientSocket(ClientSocket* clientSocket) throw() { a_clientSocket = clientSocket; }
 104
 105   friend class ServerSocket;
 106   friend class handler::ServerSocket;
 107 };
 108
 109 }
 110 }
 111
 112 #endif
 113