Lunchbox  1.10.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
timedLock.h
1 
2 /* Copyright (c) 2005-2014, 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_TIMEDLOCK_H
19 #define LUNCHBOX_TIMEDLOCK_H
20 
21 #include <lunchbox/api.h>
22 #include <lunchbox/types.h>
23 #include <boost/noncopyable.hpp>
24 
25 namespace lunchbox
26 {
27 namespace detail { class TimedLock; }
28 
35 class TimedLock : public boost::noncopyable
36 {
37 public:
39  LUNCHBOX_API TimedLock();
40 
42  LUNCHBOX_API ~TimedLock();
43 
52  LUNCHBOX_API bool set( const uint32_t timeout = LB_TIMEOUT_INDEFINITE );
53 
55  LUNCHBOX_API void unset();
56 
63  LUNCHBOX_API bool trySet();
64 
71  LUNCHBOX_API bool isSet();
72 
73 private:
74  detail::TimedLock* const _impl;
75 }; // LB_DEPRECATED;
76 }
77 #endif //LUNCHBOX_TIMEDLOCK_H
Defines export visibility macros for Lunchbox.
Basic type definitions not provided by the operating system.
A mutex with timeout capabilities.
Definition: timedLock.h:35
#define LB_TIMEOUT_INDEFINITE
Constant defining 'wait forever' in methods with wait parameters.
Definition: types.h:106
LUNCHBOX_API bool trySet()
Attempt to set the lock.
LUNCHBOX_API void unset()
Release the lock.
LUNCHBOX_API ~TimedLock()
Destruct the lock.
LUNCHBOX_API bool isSet()
Test if the lock is set.
LUNCHBOX_API TimedLock()
Construct a new timed lock.
LUNCHBOX_API bool set(const uint32_t timeout=LB_TIMEOUT_INDEFINITE)
Set the lock.