Server/include/plaqui/server/controlclient.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_CONTROLCLIENT_H
  29 #define PLAQUI_CONTROLCLIENT_H
  30
  31 #include "plaqui/server/command.h"
  32 #include "plaqui/server/connection.h"
  33 #include "plaqui/server/receiver.h" // TODO TEMPRORAL
  34 #include <string>
  35
  36 namespace PlaQui {
  37
  38 namespace Server {
  39
  40         /// Conexión para enviar comandos de control a una planta.
  41         class ControlClient: public Connection {
  42
  43                 // Tipos.
  44
  45                 public:
  46
  47                         /// Tipo de señal para indicar que se conectó.
  48                         typedef SigC::Signal0<void> SignalConnected;
  49
  50                         /// Tipo de señal para indicar que se recibió una respuesta OK.
  51                         typedef SigC::Signal1<void, const std::string&> SignalOKReceived;
  52
  53                         /// Tipo de señal para indicar que se recibió un error.
  54                         typedef SigC::Signal1<void, unsigned> SignalErrorReceived;
  55
  56                 // Atributos.
  57
  58                 protected:
  59
  60                         /// Señal para indicar que se conectó.
  61                         SignalConnected connected;
  62
  63                         /// Señal para indicar que se recibió una respuesta OK.
  64                         SignalOKReceived ok_received;
  65
  66                         /// Señal para indicar que se recibió un error.
  67                         SignalErrorReceived error_received;
  68
  69                         /// Receptor del estado de la planta TODO Temporal.
  70                         Receiver receiver;
  71
  72                 // Métodos.
  73
  74                 private:
  75
  76                         /**
  77                          * Realiza la conexión al servidor.
  78                          */
  79                         virtual void real_run(void);
  80
  81                 public:
  82
  83                         /**
  84                          * Destructor.
  85                          */
  86                         virtual ~ControlClient(void);
  87
  88                         /**
  89                          * Constructor.
  90                          *
  91                          * \param _host Host al cual conectarse para enviar comandos de
  92                          *                         control.
  93                          * \param _port Puerto al cual conectarse.
  94                          */
  95                         ControlClient(const std::string& _host = "localhost",
  96                                         const Connection::Port& _port = 7522) throw(sockerr);
  97
  98                         /**
  99                          * Envía un comando al servidor.
 100                          *
 101                          * \param command Comando a enviar.
 102                          */
 103                         void send(const Command& command);
 104
 105                         /**
 106                          * Obtiene la señal para indicar que se conectó.
 107                          */
 108                         SignalConnected& signal_connected(void);
 109
 110                         /**
 111                          * Obtiene la señal para indicar que se recibió una respuesta OK.
 112                          */
 113                         SignalOKReceived& signal_ok_received(void);
 114
 115                         /**
 116                          * Obtiene la señal para indicar que se recibió un error.
 117                          */
 118                         SignalErrorReceived& signal_error_received(void);
 119
 120                         /**
 121                          * Obtiene la señal que avisa cuando se recibió un cuadro.
 122                          */
 123                         Receiver::SignalFrameReceived& signal_frame_received(void);
 124
 125         };
 126
 127 }
 128
 129 }
 130
 131 #endif // PLAQUI_CONTROLCLIENT_H