include/anna/core/mt/Guard.hpp

   1 // ANNA - Anna is Not Nothingness Anymore                                                         //
   2 //                                                                                                //
   3 // (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo                         //
   4 //                                                                                                //
   5 // See project site at http://redmine.teslayout.com/projects/anna-suite                           //
   6 // See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
   7
   8
   9 #ifndef anna_core_mt_Guard_hpp
  10 #define anna_core_mt_Guard_hpp
  11
  12 #include <anna/core/RuntimeException.hpp>
  13 #include <anna/core/mt/Safe.hpp>
  14
  15 namespace anna {
  16
  17 /**
  18   Guarda de seccion critica para cualquier tipo de objeto.
  19
  20   Asegura que las secciones criticas son iniciadas y terminadas correctamente, ademas
  21   en caso de terminar la seccion critica debido a una excepcion el mutex es liberado
  22   correctamente.
  23
  24   De esta forma nos aseguramos que solo un unico threads sera capaz de acceder y/o modificar
  25   simultaneamente el valor del miembro una instancia de la clase A.
  26
  27   Observar que todos los metodos que establezcan una seccion critica debe estar preparados
  28   para lanzar una excepcion de tipo  anna::RuntimeException.
  29
  30   Para poder acceder a toda la funcionalidad de esta clase el codigo debe ser compilado
  31   con la definicion de la macro _MT.
  32
  33   @see Safe.
  34 */
  35 class Guard {
  36 public:
  37   /**
  38     Constructor.
  39     @param object Sobre el que actuar para iniciar la guarda.
  40   */
  41   Guard(const Safe& object) noexcept(false) : a_whatis(NULL) {
  42     lock(a_safeObject = const_cast <Safe*>(&object), NULL);
  43   }
  44
  45   /**
  46     Constructor.
  47     @param object Sobre el que actuar para iniciar la guarda.
  48   */
  49   Guard(const Safe* object) noexcept(false);
  50
  51   /**
  52     Constructor.
  53     @param object Sobre el que actuar para iniciar la guarda.
  54     @param whatis Texto que indica la naturaleza del objeto a bloquear.
  55   */
  56   Guard(const Safe& object, const char* whatis) noexcept(false) : a_whatis(whatis) {
  57     lock(a_safeObject = const_cast <Safe*>(&object), whatis);
  58   }
  59
  60   /**
  61     Constructor.
  62     @param object Sobre el que actuar para iniciar la guarda.
  63     @param whatis Texto que indica la naturaleza del objeto a bloquear.
  64   */
  65   Guard(const Safe* object, const char* whatis) noexcept(false);
  66
  67   /**
  68     Destructor.
  69     Termina la guarda iniciada con el objeto recibido como parametro en el
  70     constructor.
  71   */
  72   virtual ~Guard() { deactivate(); }
  73
  74   /**
  75      Desactiva la seccion critica antes de que termine el ambito de actuacion de la misma.
  76   */
  77   void deactivate() ;
  78
  79 private:
  80   Safe* a_safeObject;
  81   const char* a_whatis;
  82
  83   void lock(Safe*, const char* whatis) noexcept(false);
  84 };
  85
  86 } //namespace anna
  87
  88 #endif