]> git.llucax.com Git - z.facultad/75.42/plaqui.git/commitdiff
Se termina de poner prolijo Runnable:
authorLeandro Lucarella <llucax@gmail.com>
Sun, 23 Nov 2003 18:14:11 +0000 (18:14 +0000)
committerLeandro Lucarella <llucax@gmail.com>
Sun, 23 Nov 2003 18:14:11 +0000 (18:14 +0000)
- Se completa la documentacion.
- Se arreglan las otras clases.

15 files changed:
Server/include/plaqui/server/controlclient.h
Server/include/plaqui/server/controlserver.h
Server/include/plaqui/server/plant.h
Server/include/plaqui/server/receiver.h
Server/include/plaqui/server/runnable.h
Server/include/plaqui/server/server.h
Server/include/plaqui/server/tcpserver.h
Server/include/plaqui/server/transmitter.h
Server/src/controlclient.cpp
Server/src/controlserver.cpp
Server/src/plant.cpp
Server/src/receiver.cpp
Server/src/runnable.cpp
Server/src/tcpserver.cpp
Server/src/transmitter.cpp

index 254f815f2d975f6a49e9767013ed76533ec28519..54b10beb6b0bf186e0e59ad0d37deaed400e7ac5 100644 (file)
@@ -79,7 +79,7 @@ namespace Server {
                        /**
                         * Realiza la conexión al servidor.
                         */
                        /**
                         * Realiza la conexión al servidor.
                         */
-                       virtual void real_run(void);
+                       virtual void real_run(void) throw();
 
                public:
 
 
                public:
 
index a5cb0feec017f6ec78841bc1ce6a877e245cfec9..c954cb1c8eb6b14ad9c5dd6eeda2744995662210 100644 (file)
@@ -65,7 +65,7 @@ namespace Server {
                        /**
                         * Atiende la conexión.
                         */
                        /**
                         * Atiende la conexión.
                         */
-                       virtual void real_run(void);
+                       virtual void real_run(void) throw();
 
                public:
 
 
                public:
 
index 753899b209a5fe06efdb67974f4dff7588e73888..9a54328ba50e400f96fba6e869fe7a80d44bbbf6 100644 (file)
@@ -76,7 +76,7 @@ namespace Server {
                        /**
                         * Corre la planta (la monitorea o la simula).
                         */
                        /**
                         * Corre la planta (la monitorea o la simula).
                         */
-                       virtual void real_run(void);
+                       virtual void real_run(void) throw();
 
                public:
 
 
                public:
 
index c33fd287b1bdfd94ffe235b606f09a6369bf4cc5..ddf4fd3810021335d7b88d6d036f0ef5eeafa845 100644 (file)
@@ -75,7 +75,7 @@ namespace Server {
                        /**
                         * Recibe la transmisión.
                         */
                        /**
                         * Recibe la transmisión.
                         */
-                       virtual void real_run(void);
+                       virtual void real_run(void) throw();
 
                public:
 
 
                public:
 
index 258cd2df131b91f6531a5f10a51c5e5977a5523c..810f5dbc3f596a9c4deecf461726cb1903325695 100644 (file)
@@ -35,7 +35,74 @@ namespace PlaQui {
 
 namespace Server {
 
 
 namespace Server {
 
-       /// ealizauna tarea (generalmente en un thread).
+       /**
+        * Objeto cuya función principal es realizar una tarea puntual.
+        *
+        * Esta el la clase base para todos objetos que realizan una tarea, ya sea
+        * en un hilo (<em>thread</em>) propio o no. Al tener esta flexibilidad hay
+        * dos formas típicas de usarlo cuyo punto en común es implementar una
+        * subclase (ya que esta clase es abstracta) y sobreescribir el método
+        * privado real_run(). Una vez hecho esto hay dos opciones más comunes
+        * según se lo corra en un thread o no:
+        * - Para correrlo en el hilo principal (esperando que termine de
+        *   ejecutarse) generalmente basta con crear el objeto de forma estática y
+        *   llamar a su método run():
+        *   \code
+        *   #include "runnable.h"
+        *   #include <iostream>
+        *
+        *   // Mi objeto que realiza la tarea.
+        *   class MiRunnable: public Runnable {
+        *       void real_run(void) { std::cout << "Corriendo." << std::endl; }
+        *   }
+        *
+        *   // Programa principal.
+        *   int main(void) {
+        *       MiRunnable runner;
+        *       runner.run(false); // Corre en el hilo principal
+        *       return 0;
+        *   }
+        *   \endcode
+        * - Para correrlo en el hilo propio el proceso es un poco más complejo, en
+        *   especial si se necesita saber cuando finalizó. Si esto no fuera
+        *   necesario, basta con crear el objeto dinámicamente y correr su método
+        *   run(). El objeto se libera automáticamente cuando termina su tarea.
+        *   Si es necesario saber cuando termina, se puede usar la señal
+        *   signal_finished(). El caso típico sería:
+        *   \code
+        *   #include "runnable.h"
+        *   #include <iostream>
+        *
+        *   // Mi objeto que realiza la tarea.
+        *   class MiRunnable: public Runnable {
+        *       void real_run(void) { std::cout << "Corriendo." << std::endl; }
+        *   }
+        *
+        *   // Puntero al objeto que realiza la tarea.
+        *   MiRunnable* runner;
+        *
+        *   // Atiende la señal que indica que el objeto terminó su tarea.
+        *   void on_finished(void) {
+        *       runner = 0;
+        *   }
+        *
+        *   // Programa principal.
+        *   int main(void) {
+        *       runner = new MiRunnable();
+        *       runner->run(); // Corre en un hilo propio
+        *       // Espera a que termine la tarea.
+        *       while (runner) {
+        *           sleep(1);
+        *       }
+        *       // No necesito liberar su memoria, se libera automáticamente.
+        *       return 0;
+        *   }
+        *   \endcode
+        *
+        * Nótese que al correr la tarea en un hilo propio no se pueden capturar
+        * errores con un bloque <tt>try;catch</tt>. Para reportar errores se provee
+        * de la señal signal_error().
+        */
        class Runnable {
 
                /////////////////////////////////////////////////////////////////////
        class Runnable {
 
                /////////////////////////////////////////////////////////////////////
@@ -46,12 +113,6 @@ namespace Server {
                        /// Error.
                        typedef unsigned Error;
 
                        /// Error.
                        typedef unsigned Error;
 
-                       /// Tipo de señal para indicar que se finalizó la tarea.
-                       typedef SigC::Signal0<void> SignalFinished;
-
-                       /// Tipo de señal para indicar que hubo un error.
-                       typedef SigC::Signal2<void, const Error&, const std::string&> SignalError;
-
                /////////////////////////////////////////////////////////////////////
                // Atributos.
 
                /////////////////////////////////////////////////////////////////////
                // Atributos.
 
@@ -103,7 +164,7 @@ namespace Server {
                        /**
                         * Realiza la terea.
                         */
                        /**
                         * Realiza la terea.
                         */
-                       virtual void real_run(void) = 0;
+                       virtual void real_run(void) throw() = 0;
 
                public:
 
 
                public:
 
@@ -133,16 +194,25 @@ namespace Server {
                         */
                        virtual void finish(void);
 
                         */
                        virtual void finish(void);
 
-                       /**
-                        * Obtiene la señal que avisa cuando la tarea es finalizada.
-                        */
+                       /////////////////////////////////////////////////////////////////
+                       /// \name Señales.
+                       //@{
+
+                       /// Tipo de señal para indicar que se finalizó la tarea.
+                       typedef SigC::Signal0<void> SignalFinished;
+
+                       /// Tipo de señal para indicar que hubo un error.
+                       typedef SigC::Signal2<void, const Error&, const std::string&>
+                               SignalError;
+
+                       /// Obtiene la señal que avisa cuando la tarea es finalizada.
                        SignalFinished& signal_finished(void);
 
                        SignalFinished& signal_finished(void);
 
-                       /**
-                        * Obtiene la señal que avisa que hubo un error.
-                        */
+                       /// Obtiene la señal que avisa que hubo un error.
                        SignalError& signal_error(void);
 
                        SignalError& signal_error(void);
 
+                       //@}
+
        };
 
 }
        };
 
 }
index f8757e7f62c997f1a0b4c79cb59b77b4ee5ebf9c..0e5fe2b7e8a9841b0c33b0721567e36297e9d186 100644 (file)
@@ -140,8 +140,8 @@ namespace Server {
                        /**
                         * Constructor.
                         *
                        /**
                         * Constructor.
                         *
-                        * \param filename Nombre del archivo con la planta a cargar.
-                        * \param port     Puerto en el cual escuchar.
+                        * \param plant_filename Nombre del archivo con la planta a cargar.
+                        * \param port           Puerto en el cual escuchar.
                         */
                        Server(const std::string& plant_filename,
                                        const Connection::Port& port = 7522) throw(sockerr);
                         */
                        Server(const std::string& plant_filename,
                                        const Connection::Port& port = 7522) throw(sockerr);
index d94918e5fdbc09f72e580698dd284449d9cdb800..2e3fb6ab4a11b6160d19c70f67222bbf5b5d57a6 100644 (file)
@@ -96,7 +96,7 @@ namespace Server {
                        /**
                         * Entra en el loop para atender conexiones.
                         */
                        /**
                         * Entra en el loop para atender conexiones.
                         */
-                       virtual void real_run(void);
+                       virtual void real_run(void) throw();
 
                protected:
 
 
                protected:
 
index 624ff3b8ac0adca616bee25fa52c612fac82c2d6..16f751d8ae3783a5fabc3f7991dd5c349d0bf07d 100644 (file)
@@ -46,7 +46,7 @@ namespace Server {
                        /**
                         * Comienza a transmitir.
                         */
                        /**
                         * Comienza a transmitir.
                         */
-                       virtual void real_run(void);
+                       virtual void real_run(void) throw();
 
                public:
 
 
                public:
 
index 653fcaecfb9424f1cce8013ac29a544e25188d7d..b8dec7402fb2a047a76c27084308b6a5a12fa7b5 100644 (file)
@@ -67,7 +67,7 @@ ControlClient::ControlClient(const string& _host,
        receiver = new Receiver(7528, host);
 }
 
        receiver = new Receiver(7528, host);
 }
 
-void ControlClient::real_run(void) {
+void ControlClient::real_run(void) throw() {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run." << endl;
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run." << endl;
index 41d54197a42cce37d37b3bdebb2b88f44c592a2e..2fd7652d4d3dfda30da0ec3972caa86e8ec1d2dd 100644 (file)
@@ -57,7 +57,7 @@ ControlServer::ControlServer(const sockbuf::sockdesc& sd):
 #endif // DEBUG
 }
 
 #endif // DEBUG
 }
 
-void ControlServer::real_run(void) {
+void ControlServer::real_run(void) throw() {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run()" << endl;
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run()" << endl;
index 0e70a1fb17c8139500897f27bfd09379bcc9d602..970fbabbb2fd2be308659ff40e4bf177584c0882 100644 (file)
@@ -80,7 +80,7 @@ Plant::Plant(const string& filename): simulator(filename), filename(filename) {
 */     
 }
 
 */     
 }
 
-void Plant::real_run(void) {
+void Plant::real_run(void) throw() {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run." << endl;
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run." << endl;
index 6e6c503492662b9be5666e1577de2a04d48d29da..ad42cfe26fcc53c12a34c82b357a2891493ed275 100644 (file)
@@ -60,7 +60,7 @@ Receiver::Receiver(const Connection::Port& port, const string& host)
 }
 
 // XXX EL XML DEBE EMPEZAR Y FINALIZAR EN UNA LINEA SEPARADA.
 }
 
 // XXX EL XML DEBE EMPEZAR Y FINALIZAR EN UNA LINEA SEPARADA.
-void Receiver::real_run(void) {
+void Receiver::real_run(void) throw() {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run." << endl;
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run." << endl;
index 7079143d86a27ba5044182299a4b3a1cd324331a..9587fd9e6691088d5e815a2dedd666fdb8850630 100644 (file)
@@ -41,15 +41,14 @@ namespace Server {
 Runnable::~Runnable(void) {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
 Runnable::~Runnable(void) {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
-               << ": destructor(this = " << this << ")"
-               << endl;
+               << ": destructor(this = " << this << ")." << endl;
 #endif // DEBUG
 }
 
 Runnable::Runnable(void): _thread(NULL), _stop(false) {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
 #endif // DEBUG
 }
 
 Runnable::Runnable(void): _thread(NULL), _stop(false) {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
-               << ": constructor." << endl;
+               << ": constructor(this = " << this << ")." << endl;
 #endif // DEBUG
 }
 
 #endif // DEBUG
 }
 
@@ -58,7 +57,9 @@ void Runnable::static_run(Runnable* runner) {
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": static_run(runner = " << runner << ")" << endl;
 #endif // DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": static_run(runner = " << runner << ")" << endl;
 #endif // DEBUG
+       // Corre tarea.
        runner->real_run();
        runner->real_run();
+       // Manda señal de tarea finalizada
        runner->_finished();
        delete runner;
 }
        runner->_finished();
        delete runner;
 }
@@ -74,7 +75,7 @@ void Runnable::run(bool detach) {
                // finalizar, pasandole el puntero al objeto.
                _thread = Glib::Thread::create(
                                SigC::bind<Runnable*>(SigC::slot(&Runnable::static_run), this),
                // finalizar, pasandole el puntero al objeto.
                _thread = Glib::Thread::create(
                                SigC::bind<Runnable*>(SigC::slot(&Runnable::static_run), this),
-                               false);//true);
+                               false);
        // Si no corremos la tarea normalmente.
        } else {
                real_run();
        // Si no corremos la tarea normalmente.
        } else {
                real_run();
index 8272e57aaf35456ce283410501ac1922dcb3e195..ab245b5bc0981bdcd96e4b35b976163b89242555 100644 (file)
@@ -115,8 +115,7 @@ void TCPServer::on_connection_finished(Connection* connection) {
 #endif // DEBUG
 }
 
 #endif // DEBUG
 }
 
-/// \todo TODO: ver tema de timeout o como salir de un accept().
-void TCPServer::real_run(void) {
+void TCPServer::real_run(void) throw() {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                <<  ": real_run()" << endl;
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                <<  ": real_run()" << endl;
index 4348da6d80e01c07f118fde1a6460ff689079c3d..9d0e24df263c02503e4a867ed8d75563ad5517ab 100644 (file)
@@ -64,8 +64,7 @@ Transmitter::Transmitter(const string& _host, const Connection::Port& _port)
 #endif // DEBUG
 }
 
 #endif // DEBUG
 }
 
-/// \todo debría dar una excepción (?)
-void Transmitter::real_run(void) {
+void Transmitter::real_run(void) throw() {
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run()." << endl;
 #ifdef DEBUG
        cerr << __FILE__ << "(" << __LINE__ << ")"
                << ": real_run()." << endl;