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