include/anna/core/mt/Safe.hpp

   1 // ANNA - Anna is Not Nothingness 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_Safe_hpp
  38 #define anna_core_mt_Safe_hpp
  39
  40 #include <anna/core/RuntimeException.hpp>
  41
  42 namespace anna {
  43
  44 class Guard;
  45
  46 /**
  47    Clase de la que pueden heredar todas las clases seguras que vayan a usar las guardas (ver Guard).
  48
  49    @see Guard
  50 */
  51 class Safe {
  52 public:
  53   /**
  54     Marca el inicio del acceso seguro a este objeto.
  55     \warning Cada invocacion a este metodo debe tener su correspondiente llamada al metodo #unlock.
  56     Es muy aconsejable delegar las llamadas a estos metodos en una instancia Guard.
  57   */
  58   virtual void lock() throw(RuntimeException) = 0;
  59
  60   /**
  61     Indica el final del acceso seguro iniciado al invocar #lock.
  62     \warning Indica el final del acceso seguro iniciado al invocar #lock.
  63     Es muy aconsejable delegar las llamadas a estos metodos en una instancia Guard.
  64   */
  65   virtual void unlock() throw() = 0;
  66
  67 protected:
  68   /**
  69      Constructor.
  70      \param mode Modo de actuacion de esta instancia en modo ST cuando montamos una
  71      seccion critca sobre este objeto. En modo MT siempre sera Mode::Normal, es decir
  72      abre una seccion critica sobre este objeto, que bloqueara a cualquier otro thread
  73      que intente acceder a el.
  74   */
  75   Safe() {}
  76 };
  77
  78 }
  79
  80 #endif