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