Server/include/plaqui/server/tcpserver.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:  Tue Oct 21 23:42:46 ART 2003
  22 // Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23 //----------------------------------------------------------------------------
  24 //
  25 // $Id$
  26 //
  27
  28 #ifndef PLAQUI_TCPSERVER_H
  29 #define PLAQUI_TCPSERVER_H
  30
  31 #include "plaqui/server/runnable.h"
  32 #include "plaqui/server/connection.h"
  33 #include <socket++/sockinet.h>
  34 #include <list>
  35 #include <vector>
  36
  37 namespace PlaQui {
  38
  39 namespace Server {
  40
  41         /**
  42          * Servidor de plantas químicas.
  43          * Maneja muchas conexiones, de control o de transmisión.
  44          */
  45         class TCPServer: public Runnable {
  46
  47                 // Constantes.
  48
  49                 private:
  50
  51                         /// Cantidad máxima de conexiones pendientes.
  52                         static const unsigned MAX_PENDING_CONNECTIONS = 10;
  53
  54                 // Tipos.
  55
  56                 private:
  57
  58                         /// Lista de conexiones de control.
  59                         typedef std::list<Connection*> ConnectionList;
  60
  61                 public:
  62
  63                         /// Información sobre una conexión de contro.
  64                         struct ConnectionInfo {
  65                                 /// Host.
  66                                 std::string host;
  67                                 /// Port.
  68                                 Connection::Port port;
  69                         };
  70
  71                         /// Lista de información de conexiones de control.
  72                         typedef std::vector<ConnectionInfo> ConnectionInfoList;
  73
  74                 // Atributos.
  75
  76                 private:
  77
  78                         /// Socket para escuchar conexiones.
  79                         sockinetbuf socket;
  80
  81                         /// Conexiones de control.
  82                         ConnectionList connections;
  83
  84                         /// Mutex para las conexiones.
  85                         Glib::Mutex connections_mutex;
  86
  87                 // Métodos.
  88
  89                 private:
  90
  91                         /**
  92                          * Entra en el loop para atender conexiones.
  93                          */
  94                         virtual void real_run(void);
  95
  96                 protected:
  97
  98                         /**
  99                          * Obtiene una nueva \ref Connection "conexión".
 100                          *
 101                          * \param sd Descriptor del socket de la nueva conexión.
 102                          *
 103                          * \return Nueva conexión.
 104                          */
 105                         virtual Connection* new_connection(const sockbuf::sockdesc& sd) = 0;
 106
 107                 public:
 108
 109                         /**
 110                          * Destructor.
 111                          */
 112                         virtual ~TCPServer(void);
 113
 114                         /**
 115                          * Constructor.
 116                          *
 117                          * \param port Puerto en el cual escuchar.
 118                          */
 119                         TCPServer(const Connection::Port& port);
 120
 121                         /**
 122                          * Finaliza la tarea.
 123                          *
 124                          * \param attach Si es true, la función no retorna hasta que no
 125                          *               finalice la tearea (no recomendable).
 126                          *
 127                          * \note Para saber cuando la tarea fue finalizada puede utilizar
 128                          *       la señal signal_finished().
 129                          */
 130                         virtual void finish(bool attach = false);
 131
 132                         /**
 133                          * Se encarga de borrar una conexión de la lista cuando finaliza.
 134                          *
 135                          * \param connection Conexión a eliminar.
 136                          */
 137                         void on_connection_finished(Connection* connection);
 138
 139                         /**
 140                          * Detiene una conexión.
 141                          */
 142                         bool disconnect(const std::string& host,
 143                                         const Connection::Port& port);
 144
 145                         /**
 146                          * Obtiene una lista conexiones de control abiertas.
 147                          */
 148                         ConnectionInfoList get_connected(void);
 149
 150         };
 151
 152 }
 153
 154 }
 155
 156 #endif // PLAQUI_TCPSERVER_H