OpenZWave Library: Mutex.h Source File

| OpenZWave Library 1.6.0

Mutex.h
Go to the documentation of this file.
1 //-----------------------------------------------------------------------------
2 //
3 // Mutex.h
4 //
5 // Cross-platform mutex
6 //
7 // Copyright (c) 2010 Mal Lansell <mal@lansell.org>
8 // All rights reserved.
9 //
10 // SOFTWARE NOTICE AND LICENSE
11 //
12 // This file is part of OpenZWave.
13 //
14 // OpenZWave is free software: you can redistribute it and/or modify
15 // it under the terms of the GNU Lesser General Public License as published
16 // by the Free Software Foundation, either version 3 of the License,
17 // or (at your option) any later version.
18 //
19 // OpenZWave is distributed in the hope that it will be useful,
20 // but WITHOUT ANY WARRANTY; without even the implied warranty of
21 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 // GNU Lesser General Public License for more details.
23 //
24 // You should have received a copy of the GNU Lesser General Public License
25 // along with OpenZWave. If not, see <http://www.gnu.org/licenses/>.
26 //
27 //-----------------------------------------------------------------------------
28 #ifndef _Mutex_H
29 #define _Mutex_H
30
31 #include "platform/Wait.h"
32
33 namespace OpenZWave
34 {
35 class MutexImpl;
36
40 class Mutex: public Wait
41 {
42 public:
47 Mutex();
48
58 bool Lock( bool const _bWait = true );
59
65 void Unlock();
66
70 virtual bool IsSignalled();
71 protected:
72
77 ~Mutex();
78
79 private:
80 Mutex( Mutex const& ); // prevent copy
81 Mutex& operator = ( Mutex const& ); // prevent assignment
82
83 MutexImpl* m_pImpl; // Pointer to an object that encapsulates the platform-specific implementation of a mutex.
84 };
85
86 } // namespace OpenZWave
87
88 #endif //_Mutex_H
89
OpenZWave::Mutex::Lock
bool Lock(bool const _bWait=true)
Definition: Mutex.cpp:69
OpenZWave::Mutex
Implements a platform-independent mutex–for serializing access to a shared resource.
Definition: Mutex.h:41
OpenZWave::Mutex::Mutex
Mutex()
Definition: Mutex.cpp:47
OpenZWave::Mutex::~Mutex
~Mutex()
Definition: Mutex.cpp:58
Wait.h
OpenZWave::Wait
Platform-independent definition of Wait objects.
Definition: Wait.h:43
OpenZWave::Mutex::Unlock
void Unlock()
Definition: Mutex.cpp:81
OpenZWave::Mutex::IsSignalled
virtual bool IsSignalled()
Definition: Mutex.cpp:98
OpenZWave
Definition: Bitfield.h:35