Server/include/plaqui/server/receiver.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_RECEIVER_H
  29 #define PLAQUI_RECEIVER_H
  30
  31 #include "plaqui/server/connection.h"
  32 #include <socket++/sockinet.h>
  33 #include <sigc++/signal.h>
  34 #include <string>
  35
  36 namespace PlaQui {
  37
  38 namespace Server {
  39
  40         /// Conexión para recibir el estado de una planta.
  41         class Receiver: public Connection {
  42
  43                 /////////////////////////////////////////////////////////////////////
  44                 // Constantes.
  45
  46                 private:
  47
  48                         /// Marca de comienzo de frame.
  49                         static const std::string FRAME_BEGIN;
  50
  51                         /// Marca de fin de frame.
  52                         static const std::string FRAME_END;
  53
  54                 /////////////////////////////////////////////////////////////////////
  55                 // Tipos.
  56
  57                 public:
  58
  59                         /// Tipo de señal para indicar que se recibió un cuadro.
  60                         typedef SigC::Signal1<void, const std::string&> SignalFrameReceived;
  61
  62
  63                 // Atributos.
  64
  65                 private:
  66
  67                         /// Señal que indica que se recibió un cuadro.
  68                         SignalFrameReceived frame_received;
  69
  70                 /////////////////////////////////////////////////////////////////////
  71                 // Métodos.
  72
  73                 private:
  74
  75                         /**
  76                          * Recibe la transmisión.
  77                          */
  78                         virtual void real_run(void);
  79
  80                 public:
  81
  82                         /**
  83                          * Destructor.
  84                          */
  85                         virtual ~Receiver(void);
  86
  87                         /**
  88                          * Constructor.
  89                          *
  90                          * \param port Puerto por el cual recibir estado de la planta.
  91                          * \param host Host del cual recibir el estado de la planta.
  92                          */
  93                         Receiver(const Connection::Port& port = 7528,
  94                                         const std::string& host = "localhost") throw(sockerr);
  95
  96                         /**
  97                          * Obtiene la señal que avisa cuando se recibió un cuadro.
  98                          */
  99                         SignalFrameReceived& signal_frame_received(void);
 100
 101         };
 102
 103 }
 104
 105 }
 106
 107 #endif // PLAQUI_RECEIVER_H