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                 /////////////////////////////////////////////////////////////////////
  42                 // Tipos.
  43
  44                 public:
  45
  46                         /// Error.
  47                         typedef unsigned Error;
  48
  49                         /// Tipo de señal para indicar que se finalizó la tarea.
  50                         typedef SigC::Signal0<void> SignalFinished;
  51
  52                         /// Tipo de señal para indicar que hubo un error.
  53                         typedef SigC::Signal2<void, const Error&, const std::string&> SignalError;
  54
  55                 /////////////////////////////////////////////////////////////////////
  56                 // Atributos.
  57
  58                 private:
  59
  60                         /// Thread en el cual correr la tarea.
  61                         Glib::Thread* _thread;
  62
  63                         /// Señal que indica que se finalizó la tarea.
  64                         SignalFinished _finished;
  65
  66                         /// Señal que indica que hubo un error.
  67                         SignalError _error;
  68
  69                         /// Indica si se debe frinalizar la tarea.
  70                         bool _stop;
  71
  72                         /// Mutex para stop.
  73                         Glib::Mutex stop_mutex;
  74
  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                         /**
  90                          * Indica si la tarea debe finalizar.
  91                          */
  92                         bool stop(void);
  93
  94                         /**
  95                          * Establece si la tarea debe finalizar.
  96                          *
  97                          * \param stop Nuevo valor.
  98                          *
  99                          * \return Valor anterior.
 100                          */
 101                         bool stop(bool stop);
 102
 103                         /**
 104                          * Realiza la terea.
 105                          */
 106                         virtual void real_run(void) = 0;
 107
 108                 public:
 109
 110                         /**
 111                          * Destructor.
 112                          */
 113                         virtual ~Runnable(void);
 114
 115                         /**
 116                          * Constructor.
 117                          */
 118                         Runnable(void);
 119
 120                         /**
 121                          * Comienza la tarea.
 122                          *
 123                          * \param detach Si es true se corre en un thread propio. Si no no
 124                          *                               retorna hasta que finaliza.
 125                          */
 126                         virtual void run(bool detach = true);
 127
 128                         /**
 129                          * Finaliza la tarea.
 130                          *
 131                          * \note Para saber cuando la tarea fue finalizada puede utilizar
 132                          *       la señal signal_finished().
 133                          */
 134                         virtual void finish(void);
 135
 136                         /**
 137                          * Obtiene la señal que avisa cuando la tarea es finalizada.
 138                          */
 139                         SignalFinished& signal_finished(void);
 140
 141                         /**
 142                          * Obtiene la señal que avisa que hubo un error.
 143                          */
 144                         SignalError& signal_error(void);
 145
 146         };
 147
 148 }
 149
 150 }
 151
 152 #endif // PLAQUI_RUNNABLE_H