Open Lighting Architecture  0.10.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Mutex.h
1 /*
2  * This library is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU Lesser General Public
4  * License as published by the Free Software Foundation; either
5  * version 2.1 of the License, or (at your option) any later version.
6  *
7  * This library is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10  * Lesser General Public License for more details.
11  *
12  * You should have received a copy of the GNU Lesser General Public
13  * License along with this library; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
15  *
16  * Mutex.h
17  * A thread object.
18  * Copyright (C) 2010 Simon Newton
19  */
20 
21 #ifndef INCLUDE_OLA_THREAD_MUTEX_H_
22 #define INCLUDE_OLA_THREAD_MUTEX_H_
23 
24 #include <pthread.h>
25 #include <ola/Clock.h>
26 #include <ola/base/Macro.h>
27 
28 namespace ola {
29 namespace thread {
30 
31 
35 class Mutex {
36  public:
37  friend class ConditionVariable;
38 
39  Mutex();
40  ~Mutex();
41 
42  void Lock();
43  bool TryLock();
44  void Unlock();
45 
46  private:
47  pthread_mutex_t m_mutex;
48 
50 };
51 
52 
57 class MutexLocker {
58  public:
59  explicit MutexLocker(Mutex *mutex);
60  ~MutexLocker();
61 
62  void Release();
63 
64  private:
65  Mutex *m_mutex;
66  bool m_requires_unlock;
67 
68  DISALLOW_COPY_AND_ASSIGN(MutexLocker);
69 };
70 
71 
76  public:
79 
80  void Wait(Mutex *mutex);
81  bool TimedWait(Mutex *mutex, const ola::TimeStamp &wake_up_time);
82 
83  void Signal();
84  void Broadcast();
85 
86  private:
87  pthread_cond_t m_condition;
88 
89  DISALLOW_COPY_AND_ASSIGN(ConditionVariable);
90 };
91 } // namespace thread
92 } // namespace ola
93 #endif // INCLUDE_OLA_THREAD_MUTEX_H_
#define DISALLOW_COPY_AND_ASSIGN(TypeName)
Creates dummy copy constructor and assignment operator declarations.
Definition: Macro.h:44
void Lock()
Definition: Mutex.cpp:46
void Unlock()
Definition: Mutex.cpp:64
void Wait(Mutex *mutex)
Definition: Mutex.cpp:112
Definition: Mutex.h:57
bool TryLock()
Definition: Mutex.cpp:55
MutexLocker(Mutex *mutex)
Definition: Mutex.cpp:72
~MutexLocker()
Definition: Mutex.cpp:81
void Signal()
Definition: Mutex.cpp:136
~ConditionVariable()
Definition: Mutex.cpp:103
bool TimedWait(Mutex *mutex, const ola::TimeStamp &wake_up_time)
Definition: Mutex.cpp:123
ConditionVariable()
Definition: Mutex.cpp:95
Helper macros.
~Mutex()
Definition: Mutex.cpp:38
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
void Broadcast()
Definition: Mutex.cpp:144
Definition: Clock.h:171
Mutex()
Definition: Mutex.cpp:30
Definition: Mutex.h:35
Definition: Mutex.h:75