Server/include/plaqui/server/runnable.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 20:55:08 2003
  22 // Autores: Leandro Lucarella <llucare@fi.uba.ar>
  23 //----------------------------------------------------------------------------
  24 //
  25 // $Id$
  26 //
  27
  28 #ifndef PLAQUI_RUNNABLE_H
  29 #define PLAQUI_RUNNABLE_H
  30
  31 #include <glibmm/thread.h>
  32 #include <sigc++/signal.h>
  33
  34 namespace PlaQui {
  35
  36 namespace Server {
  37
  38         /// ealizauna tarea (generalmente en un thread).
  39         class Runnable {
  40
  41                 // Tipos.
  42
  43                 public:
  44
  45                         /// Error.
  46                         typedef unsigned Error;
  47
  48                         /// Tipo de señal para indicar que se finalizó la tarea.
  49                         typedef SigC::Signal0<void> SignalFinished;
  50
  51                         /// Tipo de señal para indicar que hubo un error.
  52                         typedef SigC::Signal2<void, const Error&, const std::string&> SignalError;
  53
  54                 // Atributos.
  55
  56                 private:
  57
  58                         /// Thread en el cual correr la tarea.
  59                         Glib::Thread* thread;
  60
  61                         /// Señal que indica que se finalizó la tarea.
  62                         SignalFinished finished;
  63
  64                 protected:
  65
  66                         /// Señal que indica que hubo un error.
  67                         SignalError error;
  68
  69                         /**
  70                          * Indica si se debe frinalizar la tarea.
  71                          *
  72                          * \todo Poner como privado y poner get() set() con locks.
  73                          */
  74                         bool stop;
  75
  76                 // Métodos.
  77
  78                 private:
  79
  80                         /**
  81                          * Corre la tarea controlando cuando termina.
  82                          *
  83                          * \param runner Objeto con la tarea a realizar.
  84                          */
  85                         static void static_run(Runnable* runner);
  86
  87                 protected:
  88
  89                         /// Realiza la terea.
  90                         virtual void real_run(void) = 0;
  91
  92                 public:
  93
  94                         /**
  95                          * Destructor.
  96                          */
  97                         virtual ~Runnable(void);
  98
  99                         /**
 100                          * Constructor.
 101                          */
 102                         Runnable(void);
 103
 104                         /**
 105                          * Comienza la tarea.
 106                          *
 107                          * \param detach Si es true se corre en un thread propio. Si no no
 108                          *                               retorna hasta que finaliza.
 109                          */
 110                         virtual void run(bool detach = true);
 111
 112                         /**
 113                          * Finaliza la tarea.
 114                          *
 115                          * \param attach Si es true, la función no retorna hasta que no
 116                          *               finalice la tearea (no recomendable).
 117                          *
 118                          * \note Para saber cuando la tarea fue finalizada puede utilizar
 119                          *       la señal signal_finished().
 120                          */
 121                         virtual void finish(bool attach = false);
 122
 123                         /**
 124                          * Obtiene la señal que avisa cuando la tarea es finalizada.
 125                          */
 126                         SignalFinished& signal_finished(void);
 127
 128                         /**
 129                          * Obtiene la señal que avisa que hubo un error.
 130                          */
 131                         SignalError& signal_error(void);
 132
 133         };
 134
 135 }
 136
 137 }
 138
 139 #endif // PLAQUI_RUNNABLE_H