1 // ANNA - Anna is Not Nothingness Anymore
3 // (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
5 // http://redmine.teslayout.com/projects/anna-suite
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
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
17 // * Neither the name of the copyright holder 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.
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.
33 // Authors: eduardo.ramos.testillano@gmail.com
34 // cisco.tierra@gmail.com
37 #ifndef anna_core_mt_Mutex_hpp
38 #define anna_core_mt_Mutex_hpp
42 #include <anna/core/mt/Safe.hpp>
47 Clase para implementar secciones criticas no-reentrantes. El uso general sera el siguiente:
53 <implementacion de la seccion critica>
59 .... tratamiento de la excepcion ...
63 La funcionalidad de esta clase solo estara disponible en aplicaciones multithread.
69 class Mutex : public Safe {
71 struct Mode { enum _v { Recursive, Strict }; };
75 explicit Mutex(const Mode::_v mode = Mode::Recursive);
82 virtual void lock() throw(RuntimeException);
84 virtual void unlock() throw();
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.
92 bool trylock() throw(RuntimeException);
95 * Operador de conversión.
96 * \return El \em pthread_mutex_t asociado a esta instancia.
98 operator const pthread_mutex_t*() const throw() {
108 pthread_mutex_t a_id;
111 Mutex(const Mutex& other);
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.
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.
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 >;
127 #define anna_access_mutex a_autoMutex