Server/include/plaqui/server/connection.h

   1 // vim: set noexpandtab tabstop=4 shiftwidth=4:
   2 //----------------------------------------------------------------------------
   3 //                                  PlaQui
   4 //----------------------------------------------------------------------------
   5 // This file is part of PlaQui.
   6 //
   7 // PlaQui is free software; you can redistribute it and/or modify it under the
   8 // terms of the GNU General Public License as published by the Free Software
   9 // Foundation; either version 2 of the License, or (at your option) any later
  10 // version.
  11 //
  12 // PlaQui is distributed in the hope that it will be useful, but WITHOUT ANY
  13 // WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  14 // FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
  15 // details.
  16 //
  17 // You should have received a copy of the GNU General Public License along
  18 // with PlaQui; if not, write to the Free Software Foundation, Inc., 59 Temple
  19 // Place, Suite 330, Boston, MA  02111-1307  USA
  20 //----------------------------------------------------------------------------
  21 // Creado:  Sat Oct 18 18:18:36 2003
  22 // Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23 //----------------------------------------------------------------------------
  24 //
  25 // $Id$
  26 //
  27
  28 #ifndef PLAQUI_CONNECTION_H
  29 #define PLAQUI_CONNECTION_H
  30
  31 #include "plaqui/server/runnable.h"
  32 #include <socket++/sockinet.h>
  33
  34 namespace PlaQui {
  35
  36 namespace Server {
  37
  38         /// Conexión.
  39         class Connection: public Runnable {
  40
  41                 // Tipos.
  42
  43                 public:
  44
  45                         /// Puerto.
  46                         typedef unsigned Port;
  47
  48                 // Atributos.
  49
  50                 protected:
  51
  52                         /// Socket a usar en la conexión.
  53                         iosockinet socket;
  54
  55                         /// Host.
  56                         std::string host;
  57
  58                         /// Puerto.
  59                         Port port;
  60
  61                         /// Mutex para el socket.
  62                         //Glib::Mutex socket_mutex;
  63
  64                 // Métodos.
  65
  66                 public:
  67
  68                         /**
  69                          * Destructor.
  70                          */
  71                         virtual ~Connection(void);
  72
  73                         /**
  74                          * Constructor.
  75                          *
  76                          * \param sd Descriptor de socket a usar en la conexión.
  77                          */
  78                         Connection(const sockbuf::sockdesc& sd);
  79
  80                         /**
  81                          * Constructor.
  82                          *
  83                          * \param type Tipo de socket a usar.
  84                          * \param host Host a donde conectarse.
  85                          * \param port Puerto al cual conectarse.
  86                          */
  87                         Connection(const sockbuf::type& type, const std::string& host,
  88                                         const Port& port);
  89
  90                         /**
  91                          * Constructor.
  92                          *
  93                          * \param host Host a donde conectarse.
  94                          * \param port Puerto al cual conectarse.
  95                          */
  96                         Connection(const std::string& host, const Port& port);
  97
  98                         /**
  99                          * Finaliza la conexión.
 100                          *
 101                          * \param attach Si es true, la función no retorna hasta que no
 102                          *               finalice la tearea (no recomendable).
 103                          *
 104                          * \note Para saber cuando la tarea fue finalizada puede utilizar
 105                          *       la señal signal_finished().
 106                          */
 107                         virtual void finish(bool attach = false);
 108
 109                         /**
 110                          * Obtiene el nombre del host local de la conexión.
 111                          * \todo TODO - Debería devolver una copia? Porque podría morir la
 112                          *       conexion y nosotros seguir usando la variable destruida.
 113                          */
 114                         const std::string& get_host(void) const;
 115
 116                         /**
 117                          * Obtiene el puerto local de la conexión.
 118                          * \todo TODO - Debería devolver una copia? Porque podría morir la
 119                          *       conexion y nosotros seguir usando la variable destruida.
 120                          */
 121                         const Port& get_port(void) const;
 122
 123         };
 124
 125 }
 126
 127 }
 128
 129 #endif // PLAQUI_CONNECTION_H