include/anna/core/mt/Mutex.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_Mutex_hpp
  38 #define anna_core_mt_Mutex_hpp
  39
  40 #include <pthread.h>
  41
  42 #include <anna/core/mt/Safe.hpp>
  43
  44 namespace anna {
  45
  46 /**
  47    Clase para implementar secciones criticas no-reentrantes. El uso general sera el siguiente:
  48
  49    \code
  50       mutex.lock ();
  51
  52       try {
  53        <implementacion de la seccion critica>
  54
  55         mutex.unlock ();
  56       }
  57       catch (Exception&) {
  58         mutex.unlock ();
  59         .... tratamiento de la excepcion ...
  60       }
  61    \endcode
  62
  63    La funcionalidad de esta clase solo estara disponible en aplicaciones multithread.
  64
  65    @see anna::Guard
  66    @see anna::Thread
  67    @see anna::Semaphore
  68 */
  69 class Mutex : public Safe {
  70 public:
  71   struct Mode { enum _v { Recursive, Strict }; };
  72   /**
  73     Constructor.
  74   */
  75   explicit Mutex(const Mode::_v mode = Mode::Recursive);
  76
  77   /**
  78     Destructor.
  79   */
  80   virtual ~Mutex();
  81
  82   virtual void lock() throw(RuntimeException);
  83
  84   virtual void unlock() throw();
  85
  86   /**
  87    * Devuelve \em true en caso de que haya conseguido bloquear el mutex, o
  88    * \em false en otro caso.
  89    * \return \em true en caso de que haya conseguido bloquear el mutex, o
  90    * \em false en otro caso.
  91    */
  92   bool trylock() throw(RuntimeException);
  93
  94   /**
  95    * Operador de conversión.
  96    * \return El \em pthread_mutex_t asociado a esta instancia.
  97    */
  98   operator const pthread_mutex_t*() const throw() {
  99 #ifdef _MT
 100     return &a_id;
 101 #else
 102     return NULL;
 103 #endif
 104   }
 105
 106 private:
 107 #ifdef _MT
 108   pthread_mutex_t a_id;
 109 #endif
 110
 111   Mutex(const Mutex& other);
 112 };
 113
 114 /**
 115  * Macro que incorpora la definición de un Mutex e implementa los métodos \em lock y \em unlock
 116  * en la clase desde la que se invoca.
 117  *
 118  * \warning Debe invocarse desde la parte privada de la clase para asegurar que las secciones críticas de la
 119  * misma sólo se activaran mediante anna::Guard<T>, que es la forma más segura y fácil.
 120  */
 121 #define anna_declare_mutex(ClassName) \
 122    anna::Mutex a_autoMutex; \
 123    void lock () throw (anna::RuntimeException) { a_autoMutex.lock (); } \
 124    void unlock () throw () { a_autoMutex.unlock (); } \
 125    friend class anna::Guard <ClassName >;
 126
 127 #define anna_access_mutex a_autoMutex
 128
 129 } //namespace anna
 130
 131 #endif