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 <sigc++/signal.h>
  35 #include <list>
  36 #include <vector>
  37
  38 namespace PlaQui {
  39
  40 namespace Server {
  41
  42         /**
  43          * Servidor de plantas químicas.
  44          * Maneja muchas conexiones, de control o de transmisión.
  45          */
  46         class TCPServer: public Runnable {
  47
  48                 /////////////////////////////////////////////////////////////////////
  49                 // Constantes.
  50
  51                 private:
  52
  53                         /// Cantidad máxima de conexiones pendientes.
  54                         static const unsigned MAX_PENDING_CONNECTIONS = 10;
  55
  56                 /////////////////////////////////////////////////////////////////////
  57                 // Tipos.
  58
  59                 private:
  60
  61                         /// Lista de conexiones de control.
  62                         typedef std::list<Connection*> ConnectionList;
  63
  64                 public:
  65
  66                         /// Información sobre una conexión de contro.
  67                         struct ConnectionInfo {
  68                                 /// Host.
  69                                 std::string host;
  70                                 /// Port.
  71                                 Connection::Port port;
  72                         };
  73
  74                         /// Lista de información de conexiones de control.
  75                         typedef std::vector<ConnectionInfo> ConnectionInfoList;
  76
  77                 /////////////////////////////////////////////////////////////////////
  78                 /// \name Señales
  79                 //@{
  80
  81                 public:
  82
  83                         /// Tipo de señal para indicar que se inició una conexión.
  84                         typedef SigC::Signal2<void, const std::string&,
  85                                         const Connection::Port&> SignalConnectionOpened;
  86
  87                         /// Obtiene la señal que avisa que se inició una conexión.
  88                         SignalConnectionOpened& signal_connection_opened(void);
  89
  90                 //@}
  91
  92                 /////////////////////////////////////////////////////////////////////
  93                 // Atributos.
  94
  95                 protected:
  96
  97                         /// Socket para escuchar conexiones.
  98                         sockinetbuf socket;
  99
 100                 private:
 101
 102                         /// Señal que indica que se inició una conexión.
 103                         SignalConnectionOpened _connection_opened;
 104
 105                         /// Conexiones de control.
 106                         ConnectionList connections;
 107
 108                         /// Mutex para las conexiones.
 109                         Glib::Mutex connections_mutex;
 110
 111                 /////////////////////////////////////////////////////////////////////
 112                 // Métodos.
 113
 114                 private:
 115
 116                         /**
 117                          * Entra en el loop para atender conexiones.
 118                          */
 119                         virtual void real_run(void) throw();
 120
 121                 protected:
 122
 123                         /**
 124                          * Obtiene una nueva \ref Connection "conexión".
 125                          *
 126                          * \param sd Descriptor del socket de la nueva conexión.
 127                          *
 128                          * \return Nueva conexión.
 129                          */
 130                         virtual Connection* new_connection(const sockbuf::sockdesc& sd) = 0;
 131
 132                 public:
 133
 134                         /**
 135                          * Destructor.
 136                          */
 137                         virtual ~TCPServer(void);
 138
 139                         /**
 140                          * Constructor.
 141                          *
 142                          * \param port Puerto en el cual escuchar.
 143                          */
 144                         TCPServer(const Connection::Port& port) throw(sockerr);
 145
 146                         /**
 147                          * Finaliza la tarea.
 148                          *
 149                          * \note Para saber cuando la tarea fue finalizada puede utilizar
 150                          *       la señal signal_finished().
 151                          */
 152                         virtual void finish(void);
 153
 154                         /**
 155                          * Se encarga de borrar una conexión de la lista cuando finaliza.
 156                          *
 157                          * \param connection Conexión a eliminar.
 158                          */
 159                         void on_connection_finished(Connection* connection);
 160
 161                         /**
 162                          * Detiene una conexión.
 163                          */
 164                         bool disconnect(const std::string& host,
 165                                         const Connection::Port& port);
 166
 167                         /**
 168                          * Obtiene una lista conexiones de control abiertas.
 169                          */
 170                         ConnectionInfoList get_connected(void);
 171
 172         };
 173
 174 }
 175
 176 }
 177
 178 #endif // PLAQUI_TCPSERVER_H