Lunchbox  1.11.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
lock.h
1 
2 /* Copyright (c) 2005-2015, Stefan Eilemann <eile@equalizergraphics.com>
3  *
4  * This library is free software; you can redistribute it and/or modify it under
5  * the terms of the GNU Lesser General Public License version 2.1 as published
6  * by the Free Software Foundation.
7  *
8  * This library is distributed in the hope that it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
10  * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
11  * details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this library; if not, write to the Free Software Foundation, Inc.,
15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
16  */
17 
18 #ifndef LUNCHBOX_LOCK_H
19 #define LUNCHBOX_LOCK_H
20 
21 #include <lunchbox/api.h>
22 #include <lunchbox/compiler.h>
23 #include <boost/noncopyable.hpp>
24 
25 namespace lunchbox
26 {
27 namespace detail { class Lock; }
28 
36 class Lock : public boost::noncopyable
37 {
38 public:
40  LUNCHBOX_API Lock();
41 
43  LUNCHBOX_API ~Lock();
44 
46  LUNCHBOX_API void set();
47 
49  LUNCHBOX_API void unset();
50 
52  void setRead() { set(); }
53 
55  void unsetRead() { unset(); }
56 
66  LUNCHBOX_API bool trySet();
67 
75  LUNCHBOX_API bool isSet();
76 
77 private:
78  detail::Lock* const _impl;
79 };// LB_DEPRECATED;
80 }
81 #endif //LUNCHBOX_LOCK_H
LUNCHBOX_API ~Lock()
Destruct the lock.
Defines export visibility macros for Lunchbox.
LUNCHBOX_API void unset()
Release the lock.
LUNCHBOX_API Lock()
Construct a new lock.
void setRead()
Acquire the lock shared with other readers.
Definition: lock.h:52
LUNCHBOX_API bool isSet()
Test if the lock is set.
LUNCHBOX_API void set()
Acquire the lock.
void unsetRead()
Release a shared read lock.
Definition: lock.h:55
LUNCHBOX_API bool trySet()
Attempt to acquire the lock.
A lock (mutex) primitive.
Definition: lock.h:36