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                         /// Tipo de señal para indicar que se finalizó la tarea.
  46                         typedef SigC::Signal0<void> SignalFinished;
  47
  48                 // Atributos.
  49
  50                 private:
  51
  52                         /// Thread en el cual correr la tarea.
  53                         Glib::Thread* thread;
  54
  55                         /// Señal que indica que se finalizó la tarea.
  56                         SignalFinished finished;
  57
  58                 protected:
  59
  60                         /**
  61                          * Indica si se debe frinalizar la tarea.
  62                          *
  63                          * \todo Poner como privado y poner get() set() con locks.
  64                          */
  65                         bool stop;
  66
  67                         /**
  68                          * Exclusión mutua.
  69                          * Recurso usado para recibir la exclusividad sobre un recurso.
  70                          */
  71                         Glib::Mutex mutex;
  72
  73                 // Métodos.
  74
  75                 private:
  76
  77                         /**
  78                          * Corre la tarea controlando cuando termina.
  79                          *
  80                          * \param runner Objeto con la tarea a realizar.
  81                          */
  82                         static void static_run(Runnable* runner);
  83
  84                 protected:
  85
  86                         /// Realiza la terea.
  87                         virtual void real_run(void) = 0;
  88
  89                 public:
  90
  91                         /**
  92                          * Destructor.
  93                          */
  94                         virtual ~Runnable(void);
  95
  96                         /**
  97                          * Constructor.
  98                          */
  99                         Runnable(void);
 100
 101                         /**
 102                          * Comienza la tarea.
 103                          *
 104                          * \param detach Si es true se corre en un thread propio. Si no no
 105                          *                               retorna hasta que finaliza.
 106                          */
 107                         virtual void run(bool detach = true);
 108
 109                         /**
 110                          * Finaliza la tarea.
 111                          *
 112                          * \param attach Si es true, la función no retorna hasta que no
 113                          *               finalice la tearea (no recomendable).
 114                          *
 115                          * \note Para saber cuando la tarea fue finalizada puede utilizar
 116                          *       la señal signal_finished().
 117                          */
 118                         virtual void finish(bool attach = false);
 119
 120                         /**
 121                          * Obtiene la señal que avisa cuando la tarea es finalizada.
 122                          *
 123                          * \see finish().
 124                          */
 125                         SignalFinished& signal_finished(void);
 126
 127         };
 128
 129 }
 130
 131 }
 132
 133 #endif // PLAQUI_RUNNABLE_H