source: vscpl/src/hu/varadiistvan/scpl/_posix/Mutex.h@ 21:22a8774452ac

Last change on this file since 21:22a8774452ac was 6:53519b47b166, checked in by István Váradi <ivaradi@…>, 12 years ago

Imported some further stuff from the IO code

File size: 3.9 KB
Line 
1// Copyright (c) 2013 by István Váradi
2
3// This file is part of VSCPL, a simple cross-platform utility library
4
5// Redistribution and use in source and binary forms, with or without
6// modification, are permitted provided that the following conditions are met:
7
8// 1. Redistributions of source code must retain the above copyright notice, this
9// list of conditions and the following disclaimer.
10// 2. Redistributions in binary form must reproduce the above copyright notice,
11// this list of conditions and the following disclaimer in the documentation
12// and/or other materials provided with the distribution.
13
14// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
15// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
18// ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
21// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24
25// The views and conclusions contained in the software and documentation are those
26// of the authors and should not be interpreted as representing official policies,
27// either expressed or implied, of the FreeBSD Project.
28
29#ifndef HU_VARADIISTVAN_SCPL_POSIX_MUTEX_H
30#define HU_VARADIISTVAN_SCPL_POSIX_MUTEX_H
31//------------------------------------------------------------------------------
32
33#include <pthread.h>
34
35//------------------------------------------------------------------------------
36
37namespace hu { namespace varadiistvan { namespace scpl {
38
39//------------------------------------------------------------------------------
40
41/**
42 * Mutual exclusion device for POSIX threads.
43 */
44class Mutex
45{
46private:
47 /**
48 * The mutex structure.
49 */
50 pthread_mutex_t mutex;
51
52public:
53 /**
54 * Construct the mutex.
55 */
56 Mutex();
57
58 /**
59 * Destroy the mutex.
60 */
61 ~Mutex();
62
63 /**
64 * Lock the mutex. If the mutex is locked by another thread, the
65 * caller one waits until the other thread releases the mutex.
66 */
67 void lock();
68
69 /**
70 * Try to lock the mutex. If the mutex is locked by another
71 * thread, this function returns false immediately. Otherwise it
72 * locks the mutex and returns true.
73 */
74 bool tryLock();
75
76 /**
77 * Unlock the mutex.
78 */
79 void unlock();
80
81 friend class CondVar;
82};
83
84//------------------------------------------------------------------------------
85// Inline definitions
86//------------------------------------------------------------------------------
87
88inline Mutex::Mutex()
89{
90 pthread_mutex_init(&mutex, 0);
91}
92
93//------------------------------------------------------------------------------
94
95inline Mutex::~Mutex()
96{
97 pthread_mutex_destroy(&mutex);
98}
99
100//------------------------------------------------------------------------------
101
102inline void Mutex::lock()
103{
104 pthread_mutex_lock(&mutex);
105}
106
107//------------------------------------------------------------------------------
108
109inline bool Mutex::tryLock()
110{
111 return pthread_mutex_trylock(&mutex)==0;
112}
113
114//------------------------------------------------------------------------------
115
116inline void Mutex::unlock()
117{
118 pthread_mutex_unlock(&mutex);
119}
120
121//------------------------------------------------------------------------------
122
123} /* namespace hu::varadiistvan::scpl */ } /* namespace hu::varadiistvan */ } /* namespace hu */
124
125//------------------------------------------------------------------------------
126#endif // HU_VARADIISTVAN_SCPL_POSIX_MUTEX_H
127
128// Local Variables:
129// mode: C++
130// c-basic-offset: 4
131// indent-tabs-mode: nil
132// End:
Note: See TracBrowser for help on using the repository browser.