Fawkes API  Fawkes Development Version
recursive_mutex.cpp
1 
2 /***************************************************************************
3  * mutex.cpp - implementation of mutex, based on pthreads
4  *
5  * Generated: Thu Sep 14 17:03:57 2006
6  * Copyright 2006 Tim Niemueller [www.niemueller.de]
7  *
8  ****************************************************************************/
9 
10 /* This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version. A runtime exception applies to
14  * this software (see LICENSE.GPL_WRE file mentioned below for details).
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU Library General Public License for more details.
20  *
21  * Read the full text in the LICENSE.GPL_WRE file in the doc directory.
22  */
23 
24 #include <core/threading/recursive_mutex.h>
25 
26 namespace fawkes {
27 
28 /** @class RecursiveMutex <core/threading/recursive_mutex.h>
29  * Recursive mutex.
30  * This is a mutex which can be locked multiple times by the same thread.
31  * Other threads attempting to lock the mutex will block as if this were a
32  * regular mutex.
33  * This class is just a convenience sub-class of Mutex with its type set
34  * to Mutex::RECURSIVE. It is meant to be used to make the actual behavior
35  * more obvious.
36  *
37  * @ingroup Threading
38  * @ingroup FCL
39  *
40  * @author Tim Niemueller
41  */
42 
43 /** Constructor. */
45  : Mutex(Mutex::RECURSIVE)
46 {
47 }
48 
49 } // end namespace fawkes
Fawkes library namespace.
RecursiveMutex()
Constructor.
Mutex mutual exclusion lock.
Definition: mutex.h:32