Lunchbox  1.13.0
Multi-threaded C++ toolbox library for all application developers creating high-performance multi-threaded programs.
condition.h
1 
2 /* Copyright (c) 2010-2014, Stefan Eilemann <eile@eyescale.ch>
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_CONDITION_H
19 #define LUNCHBOX_CONDITION_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 Condition; }
28 
33 class Condition : public boost::noncopyable
34 {
35 public:
37  LUNCHBOX_API Condition();
38 
40  LUNCHBOX_API ~Condition();
41 
43  LUNCHBOX_API void lock();
44 
46  LUNCHBOX_API void unlock();
47 
49  LUNCHBOX_API void signal();
50 
52  LUNCHBOX_API void broadcast();
53 
58  LUNCHBOX_API void wait();
59 
70  LUNCHBOX_API bool timedWait( const uint32_t timeout );
71 
72 private:
73  detail::Condition* const _impl;
74 };
75 }
76 
77 #endif //LUNCHBOX_CONDITION_H
Defines export visibility macros for library Lunchbox.
Basic type definitions not provided by the operating system.
A condition variable and associated lock.
Definition: condition.h:33
Condition()
Construct a new condition variable.
void unlock()
Unlock the mutex.
bool timedWait(const uint32_t timeout)
Atomically unlock the mutex, wait for a signal and relock the mutex.
void lock()
Lock the mutex.
void broadcast()
Broadcast the condition.
Abstraction layer and common utilities for multi-threaded programming.
Definition: algorithm.h:32
void signal()
Signal the condition.
~Condition()
Destruct this condition variable.
void wait()
Atomically unlock the mutex, wait for a signal and relock the mutex.