Server/include/plaqui/server/server.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_SERVER_H
  29 #define PLAQUI_SERVER_H
  30
  31 #include "plaqui/server/tcpserver.h"
  32 #include "plaqui/server/controlserver.h"
  33 #include "plaqui/server/transmitter.h"
  34 #include "plaqui/server/command.h"
  35 #include <socket++/sockinet.h>
  36 #include <string>
  37 #include <list>
  38
  39 namespace PlaQui {
  40
  41 namespace Server {
  42
  43         /**
  44          * Servidor de plantas químicas.
  45          * Maneja múltiples conexiones, de control o de transmisión.
  46          */
  47         class Server: public TCPServer {
  48
  49                 // Tipos.
  50
  51                 private:
  52
  53                         /// Lista de conexiones de control.
  54                         typedef std::list<Transmitter*> TransmitterList;
  55
  56                         // TODO:
  57                         // typedef std::list<Plant*> PlantList;
  58
  59                 // Atributos.
  60
  61                 private:
  62
  63                         /// Transmisiones del estado de las plantas.
  64                         TransmitterList transmissions;
  65
  66                         // TODO:
  67                         // PlantList plants;
  68
  69                 // Métodos.
  70
  71                 protected:
  72
  73                         /**
  74                          * Obtiene una nueva \ref Connection "conexión".
  75                          *
  76                          * \param sd Descriptor del socket de la nueva conexión.
  77                          *
  78                          * \return Nueva conexión.
  79                          */
  80                         virtual Connection* new_connection(const sockbuf::sockdesc& sd);
  81
  82                 public:
  83
  84                         /**
  85                          * Destructor.
  86                          */
  87                         virtual ~Server(void);
  88
  89                         /**
  90                          * Constructor.
  91                          *
  92                          * \param port Puerto en el cual escuchar.
  93                          */
  94                         Server(int port = 7522);
  95
  96                         /**
  97                          * Comienza la transimisión del estado de una planta.
  98                          *
  99                          * \param host Host al cual se quiere transmitir.
 100                          * \param port Puerto al cual transmitir.
 101                          *
 102                          * \return true si se pudo empezar a transmitir, false si no.
 103                          *
 104                          * \todo Ver si es necesario que devuelva algo y si devuelve ver si
 105                          *       no sería mejor que dé más información (si no se pudo abrir
 106                          *       o si ya estaba abierto por ejemplo.
 107                          */
 108                         bool start_transmission(std::string host = "localhost",
 109                                         int port = 7528);
 110
 111                         /**
 112                          * Finaliza la transimisión del estado de una planta.
 113                          *
 114                          * \param host Host al cual se quiere dejar de transmitir.
 115                          * \param port Puerto al cual dejar de transmitir.
 116                          *
 117                          * \return true si se pudo empezar a transmitir, false si no.
 118                          *
 119                          * \todo Ver de hacer un TransmissionManager.
 120                          */
 121                         bool stop_transmission(std::string host, int port);
 122
 123                         /**
 124                          * Maneja los comandos recibidos por las conexiones.
 125                          *
 126                          * \todo Hacer un tipo Command abstracto o algo así.
 127                          */
 128                         void on_control_command_received(const Command& command,
 129                                         ControlServer* server);
 130
 131         };
 132
 133 }
 134
 135 }
 136
 137 #endif // PLAQUI_SERVER_H