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/plant.h"
  35 #include "plaqui/server/command.h"
  36 #include "plaqui/server/response.h"
  37 #include <socket++/sockinet.h>
  38 #include <string>
  39 #include <map>
  40
  41 namespace PlaQui {
  42
  43 namespace Server {
  44
  45         /**
  46          * Servidor de plantas químicas.
  47          *
  48          * Esta clase se encarga, entre otras cosas, de definir el método
  49          * new_connection() de TCPServer para crear una nueva
  50          * \ref ControlServer "conexión de control" para atender las conexiones que
  51          * éste recibe.
  52          *
  53          * Una vez recibida una conexión, esta clase se encarga de manejar los
  54          * comandos que a través de ella se reciben a través de los métodos como
  55          * cmd_server_info(), cmd_connection_list(), etc.
  56          *
  57          * Esta clase es también la encargado de mantener la \ref plants "lista" de
  58          * \ref Plant "plantas" que se están sirviendo (y simulando).
  59          */
  60         class Server: public TCPServer {
  61
  62                 /////////////////////////////////////////////////////////////////////
  63                 // Tipos.
  64
  65                 private:
  66
  67                         /// Lista de plantas químicas.
  68                         typedef std::map<std::string, Plant*> PlantList;
  69
  70                 /////////////////////////////////////////////////////////////////////
  71                 // Atributos.
  72
  73                 private:
  74
  75                         // Plantas disponibles en el servidor.
  76                         PlantList plants;
  77
  78                         /// Mutex para las plantas.
  79                         Glib::Mutex plants_mutex;
  80
  81                 /////////////////////////////////////////////////////////////////////
  82                 // Métodos.
  83
  84                 protected:
  85
  86                         /**
  87                          * Obtiene una nueva \ref Connection "conexión".
  88                          *
  89                          * \param sd Descriptor del socket de la nueva conexión.
  90                          *
  91                          * \return Nueva conexión.
  92                          */
  93                         virtual Connection* new_connection(const sockbuf::sockdesc& sd);
  94
  95                         /**
  96                          * Maneja el comando server/info.
  97                          */
  98                         Response* cmd_server_info(void) const;
  99
 100                         /**
 101                          * Maneja el comando connection/list.
 102                          */
 103                         Response* cmd_connection_list(void);
 104
 105                         /**
 106                          * Maneja el comando connection/stop.
 107                          */
 108                         Response* cmd_connection_stop(const Command& command);
 109
 110                         /**
 111                          * Maneja el comando transmission/list.
 112                          */
 113                         Response* cmd_transmission_list(void);
 114
 115                         /**
 116                          * Maneja el comando transmission/start.
 117                          */
 118                         Response* cmd_transmission_start(const Command& command);
 119
 120                         /**
 121                          * Maneja el comando transmission/stop.
 122                          */
 123                         Response* cmd_transmission_stop(const Command& command);
 124
 125                         /**
 126                          * Maneja el comando plant/list.
 127                          */
 128                         Response* cmd_plant_list(void);
 129
 130                         /**
 131                          * Maneja el comando plant/get.
 132                          */
 133                         Response* cmd_plant_get(const Command& command);
 134
 135                         /**
 136                          * Maneja el comando plant/set.
 137                          */
 138                         Response* cmd_plant_set(const Command& command);
 139
 140                         /**
 141                          * Maneja el comando plant/set_frequency.
 142                          */
 143                         Response* cmd_plant_set_frequency(const Command& command);
 144
 145                         /**
 146                          * Maneja el comando plant/start.
 147                          */
 148                         Response* cmd_plant_start(const Command& command);
 149
 150                         /**
 151                          * Maneja el comando plant/stop.
 152                          */
 153                         Response* cmd_plant_stop(const Command& command);
 154
 155                         /**
 156                          * Maneja el comando plant/remove.
 157                          */
 158                         Response* cmd_plant_remove(const Command& command);
 159
 160                 public:
 161
 162                         /**
 163                          * Destructor.
 164                          */
 165                         virtual ~Server(void);
 166
 167                         /**
 168                          * Constructor.
 169                          *
 170                          * \param port Puerto en el cual escuchar.
 171                          */
 172                         Server(const Connection::Port& port = 7522) throw(sockerr);
 173
 174                         /**
 175                          * Agrega una planta al servidor.
 176                          *
 177                          * \param name     Nombre que utilizará el servidor para identificar
 178                          *                 a la planta.
 179                          * \param filename Nombre del archivo con la planta a cargar.
 180                          * \return true si se agregó la planta, false si ya existía una
 181                          *         planta con ese nombre.
 182                          */
 183                         bool add_plant(const std::string& name,
 184                                         const std::string& filename);
 185
 186                         /**
 187                          * Maneja los comandos recibidos por las conexiones.
 188                          */
 189                         void on_control_command_received(const Command& command,
 190                                         ControlServer* controlserver);
 191
 192                         /**
 193                          * Se encarga de borrar una planta de la lista cuando finaliza.
 194                          *
 195                          * \param plant Nombre de la planta a elminar.
 196                          */
 197                         void on_plant_finished(const char* plant);
 198
 199         };
 200
 201 }
 202
 203 }
 204
 205 #endif // PLAQUI_SERVER_H