include/anna/core/mt/Guard.hpp

   1 // ANNA - Anna is Not 'N' Anymore
   2 //
   3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
   4 //
   5 // https://bitbucket.org/testillano/anna
   6 //
   7 // Redistribution and use in source and binary forms, with or without
   8 // modification, are permitted provided that the following conditions
   9 // are met:
  10 //
  11 //     * Redistributions of source code must retain the above copyright
  12 // notice, this list of conditions and the following disclaimer.
  13 //     * Redistributions in binary form must reproduce the above
  14 // copyright notice, this list of conditions and the following disclaimer
  15 // in the documentation and/or other materials provided with the
  16 // distribution.
  17 //     * Neither the name of Google Inc. nor the names of its
  18 // contributors may be used to endorse or promote products derived from
  19 // this software without specific prior written permission.
  20 //
  21 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32 //
  33 // Authors: eduardo.ramos.testillano@gmail.com
  34 //          cisco.tierra@gmail.com
  35
  36
  37 #ifndef anna_core_mt_Guard_hpp
  38 #define anna_core_mt_Guard_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41 #include <anna/core/mt/Safe.hpp>
  42
  43 namespace anna {
  44
  45 /**
  46   Guarda de seccion critica para cualquier tipo de objeto.
  47
  48   Asegura que las secciones criticas son iniciadas y terminadas correctamente, ademas
  49   en caso de terminar la seccion critica debido a una excepcion el mutex es liberado
  50   correctamente.
  51
  52   De esta forma nos aseguramos que solo un unico threads sera capaz de acceder y/o modificar
  53   simultaneamente el valor del miembro una instancia de la clase A.
  54
  55   Observar que todos los metodos que establezcan una seccion critica debe estar preparados
  56   para lanzar una excepcion de tipo  anna::RuntimeException.
  57
  58   Para poder acceder a toda la funcionalidad de esta clase el codigo debe ser compilado
  59   con la definicion de la macro _MT.
  60
  61   @see Safe.
  62 */
  63 class Guard {
  64 public:
  65   /**
  66     Constructor.
  67     @param object Sobre el que actuar para iniciar la guarda.
  68   */
  69   Guard(const Safe& object) throw(RuntimeException) : a_whatis(NULL) {
  70     lock(a_safeObject = const_cast <Safe*>(&object), NULL);
  71   }
  72
  73   /**
  74     Constructor.
  75     @param object Sobre el que actuar para iniciar la guarda.
  76   */
  77   Guard(const Safe* object) throw(RuntimeException);
  78
  79   /**
  80     Constructor.
  81     @param object Sobre el que actuar para iniciar la guarda.
  82     @param whatis Texto que indica la naturaleza del objeto a bloquear.
  83   */
  84   Guard(const Safe& object, const char* whatis) throw(RuntimeException) : a_whatis(whatis) {
  85     lock(a_safeObject = const_cast <Safe*>(&object), whatis);
  86   }
  87
  88   /**
  89     Constructor.
  90     @param object Sobre el que actuar para iniciar la guarda.
  91     @param whatis Texto que indica la naturaleza del objeto a bloquear.
  92   */
  93   Guard(const Safe* object, const char* whatis) throw(RuntimeException);
  94
  95   /**
  96     Destructor.
  97     Termina la guarda iniciada con el objeto recibido como parametro en el
  98     constructor.
  99   */
 100   virtual ~Guard() throw() { deactivate(); }
 101
 102   /**
 103      Desactiva la seccion critica antes de que termine el ambito de actuacion de la misma.
 104   */
 105   void deactivate() throw();
 106
 107 private:
 108   Safe* a_safeObject;
 109   const char* a_whatis;
 110
 111   void lock(Safe*, const char* whatis) throw(RuntimeException);
 112 };
 113
 114 } //namespace anna
 115
 116 #endif