]> git.llucax.com Git - z.facultad/75.42/plaqui.git/blob - Server/include/plaqui/server/server.h
Fixes de documentacion.
[z.facultad/75.42/plaqui.git] / 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 <socket++/sockinet.h>
37 #include <string>
38 #include <map>
39
40 namespace PlaQui {
41
42 namespace Server {
43
44         /**
45          * Servidor de plantas químicas.
46          * Maneja múltiples conexiones, de control o de transmisión.
47          */
48         class Server: public TCPServer {
49
50                 /////////////////////////////////////////////////////////////////////
51                 // Tipos.
52
53                 private:
54
55                         /// Lista de plantas químicas.
56                         typedef std::map<std::string, Plant*> PlantList;
57
58                 /////////////////////////////////////////////////////////////////////
59                 // Atributos.
60
61                 private:
62
63                         // Plantas disponibles en el servidor.
64                         PlantList plants;
65
66                         /// Mutex para las plantas.
67                         Glib::Mutex plants_mutex;
68
69                 /////////////////////////////////////////////////////////////////////
70                 // Métodos.
71
72                 protected:
73
74                         /**
75                          * Obtiene una nueva \ref Connection "conexión".
76                          *
77                          * \param sd Descriptor del socket de la nueva conexión.
78                          *
79                          * \return Nueva conexión.
80                          */
81                         virtual Connection* new_connection(const sockbuf::sockdesc& sd);
82
83                         /**
84                          * Maneja el comando server/status.
85                          */
86                         HTTPResponse* cmd_server_status(void) const;
87
88                         /**
89                          * Maneja el comando connection/list.
90                          */
91                         HTTPResponse* cmd_connection_list(void);
92
93                         /**
94                          * Maneja el comando connection/stop.
95                          */
96                         HTTPResponse* cmd_connection_stop(const Command& command);
97
98                         /**
99                          * Maneja el comando transmission/list.
100                          */
101                         HTTPResponse* cmd_transmission_list(void);
102
103                         /**
104                          * Maneja el comando transmission/start.
105                          */
106                         HTTPResponse* cmd_transmission_start(const Command& command);
107
108                         /**
109                          * Maneja el comando transmission/stop.
110                          */
111                         HTTPResponse* cmd_transmission_stop(const Command& command);
112
113                         /**
114                          * Maneja el comando plant/list.
115                          */
116                         HTTPResponse* cmd_plant_list(void);
117
118                         /**
119                          * Maneja el comando plant/get.
120                          */
121                         HTTPResponse* cmd_plant_get(const Command& command);
122
123                         /**
124                          * Maneja el comando plant/get.
125                          */
126                         HTTPResponse* cmd_plant_set(const Command& command);
127
128                         /**
129                          * Maneja el comando plant/stop.
130                          */
131                         HTTPResponse* cmd_plant_stop(const Command& command);
132
133                 public:
134
135                         /**
136                          * Destructor.
137                          */
138                         virtual ~Server(void);
139
140                         /**
141                          * Constructor.
142                          *
143                          * \param plant_filename Nombre del archivo con la planta a cargar.
144                          * \param port           Puerto en el cual escuchar.
145                          */
146                         Server(const std::string& plant_filename,
147                                         const Connection::Port& port = 7522) throw(sockerr);
148
149                         /**
150                          * Maneja los comandos recibidos por las conexiones.
151                          */
152                         void on_control_command_received(const Command& command,
153                                         ControlServer* controlserver);
154
155                         /**
156                          * Se encarga de borrar una planta de la lista cuando finaliza.
157                          *
158                          * \param plant Nombre de la planta a elminar.
159                          */
160                         void on_plant_finished(const char* plant);
161
162         };
163
164 }
165
166 }
167
168 #endif // PLAQUI_SERVER_H