Fixes de documentacion.

[z.facultad/75.42/plaqui.git] / Server / include / plaqui / server / controlclient.h

diff --git a/Server/include/plaqui/server/controlclient.h b/Server/include/plaqui/server/controlclient.h
index 50ebe2aaf3b4f890cca0d8ebb7860d670b4d2a4c..8de78d765278c072c7d781cd8ea6f5afa0ff7516 100644 (file)
--- a/Server/include/plaqui/server/controlclient.h
+++ b/Server/include/plaqui/server/controlclient.h
@@ -30,6 +30,7 @@
 
 #include "plaqui/server/command.h"
 #include "plaqui/server/connection.h"
+#include "plaqui/server/receiver.h" // TODO TEMPRORAL
 #include <string>
 
 namespace PlaQui {
@@ -39,12 +40,16 @@ namespace Server {
        /// Conexión para enviar comandos de control a una planta.
        class ControlClient: public Connection {
 
+               /////////////////////////////////////////////////////////////////////
                // Tipos.
 
                public:
 
-                       /// Tipo de señal para indicar que se conectó.
-                       typedef SigC::Signal0<void> SignalConnected;
+               /////////////////////////////////////////////////////////////////////
+               /// \name Señales
+               //@{
+
+               public:
 
                        /// Tipo de señal para indicar que se recibió una respuesta OK.
                        typedef SigC::Signal1<void, const std::string&> SignalOKReceived;
@@ -52,20 +57,31 @@ namespace Server {
                        /// Tipo de señal para indicar que se recibió un error.
                        typedef SigC::Signal1<void, unsigned> SignalErrorReceived;
 
-               // Atributos.
+                       /// Tipo de señal para indicar que se recibió un frame. FIXME
+                       typedef Receiver::SignalFrameReceived SignalFrameReceived;
 
-               private:
+                       /**
+                        * Obtiene la señal para indicar que se recibió una respuesta OK.
+                        */
+                       SignalOKReceived& signal_ok_received(void);
 
-                       /// Host al cual conectarse.
-                       std::string host;
+                       /**
+                        * Obtiene la señal para indicar que se recibió un error.
+                        */
+                       SignalErrorReceived& signal_error_received(void);
 
-                       /// Puerto al cual conectarse.
-                       int port;
+                       /**
+                        * Obtiene la señal que avisa cuando se recibió un cuadro.
+                        * \todo TODO Temporal.
+                        */
+                       SignalFrameReceived& signal_frame_received(void);
 
-               protected:
+               //@}
+
+               /////////////////////////////////////////////////////////////////////
+               // Atributos.
 
-                       /// Señal para indicar que se conectó.
-                       SignalConnected connected;
+               protected:
 
                        /// Señal para indicar que se recibió una respuesta OK.
                        SignalOKReceived ok_received;
@@ -73,6 +89,10 @@ namespace Server {
                        /// Señal para indicar que se recibió un error.
                        SignalErrorReceived error_received;
 
+                       /// Receptor del estado de la planta TODO Temporal.
+                       Receiver* receiver;
+
+               /////////////////////////////////////////////////////////////////////
                // Métodos.
 
                private:
@@ -80,7 +100,7 @@ namespace Server {
                        /**
                         * Realiza la conexión al servidor.
                         */
-                       virtual void real_run(void);
+                       virtual void real_run(void) throw();
 
                public:
 
@@ -92,11 +112,12 @@ namespace Server {
                        /**
                         * Constructor.
                         *
-                        * \param host Host al cual conectarse para enviar comandos de
+                        * \param _host Host al cual conectarse para enviar comandos de
                         *                         control.
-                        * \param port Puerto al cual conectarse.
+                        * \param _port Puerto al cual conectarse.
                         */
-                       ControlClient(std::string host = "localhost", int port = 7522);
+                       ControlClient(const std::string& _host = "localhost",
+                                       const Connection::Port& _port = 7522) throw(sockerr);
 
                        /**
                         * Envía un comando al servidor.
@@ -105,21 +126,6 @@ namespace Server {
                         */
                        void send(const Command& command);
 
-                       /**
-                        * Obtiene la señal para indicar que se conectó.
-                        */
-                       SignalConnected& signal_connected(void);
-
-                       /**
-                        * Obtiene la señal para indicar que se recibió una respuesta OK.
-                        */
-                       SignalOKReceived& signal_ok_received(void);
-
-                       /**
-                        * Obtiene la señal para indicar que se recibió un error.
-                        */
-                       SignalErrorReceived& signal_error_received(void);
-
        };
 
 }