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