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                 /////////////////////////////////////////////////////////////////////
  48                 // Constantes.
  49
  50                 private:
  51
  52                         /// Cantidad máxima de conexiones pendientes.
  53                         static const unsigned MAX_PENDING_CONNECTIONS = 10;
  54
  55                 /////////////////////////////////////////////////////////////////////
  56                 // Tipos.
  57
  58                 private:
  59
  60                         /// Lista de conexiones de control.
  61                         typedef std::list<Connection*> ConnectionList;
  62
  63                 public:
  64
  65                         /// Información sobre una conexión de contro.
  66                         struct ConnectionInfo {
  67                                 /// Host.
  68                                 std::string host;
  69                                 /// Port.
  70                                 Connection::Port port;
  71                         };
  72
  73                         /// Lista de información de conexiones de control.
  74                         typedef std::vector<ConnectionInfo> ConnectionInfoList;
  75
  76                 /////////////////////////////////////////////////////////////////////
  77                 // Atributos.
  78
  79                 protected: //FIXME
  80
  81                         /// Socket para escuchar conexiones.
  82                         sockinetbuf socket;
  83                 private: // FIXME
  84
  85                         /// Conexiones de control.
  86                         ConnectionList connections;
  87
  88                         /// Mutex para las conexiones.
  89                         Glib::Mutex connections_mutex;
  90
  91                 /////////////////////////////////////////////////////////////////////
  92                 // Métodos.
  93
  94                 private:
  95
  96                         /**
  97                          * Entra en el loop para atender conexiones.
  98                          */
  99                         virtual void real_run(void) throw();
 100
 101                 protected:
 102
 103                         /**
 104                          * Obtiene una nueva \ref Connection "conexión".
 105                          *
 106                          * \param sd Descriptor del socket de la nueva conexión.
 107                          *
 108                          * \return Nueva conexión.
 109                          */
 110                         virtual Connection* new_connection(const sockbuf::sockdesc& sd) = 0;
 111
 112                 public:
 113
 114                         /**
 115                          * Destructor.
 116                          */
 117                         virtual ~TCPServer(void);
 118
 119                         /**
 120                          * Constructor.
 121                          *
 122                          * \param port Puerto en el cual escuchar.
 123                          */
 124                         TCPServer(const Connection::Port& port) throw(sockerr);
 125
 126                         /**
 127                          * Finaliza la tarea.
 128                          *
 129                          * \note Para saber cuando la tarea fue finalizada puede utilizar
 130                          *       la señal signal_finished().
 131                          */
 132                         virtual void finish(void);
 133
 134                         /**
 135                          * Se encarga de borrar una conexión de la lista cuando finaliza.
 136                          *
 137                          * \param connection Conexión a eliminar.
 138                          */
 139                         void on_connection_finished(Connection* connection);
 140
 141                         /**
 142                          * Detiene una conexión.
 143                          */
 144                         bool disconnect(const std::string& host,
 145                                         const Connection::Port& port);
 146
 147                         /**
 148                          * Obtiene una lista conexiones de control abiertas.
 149                          */
 150                         ConnectionInfoList get_connected(void);
 151
 152         };
 153
 154 }
 155
 156 }
 157
 158 #endif // PLAQUI_TCPSERVER_H