Condition.h
1/*
2 * Copyright (C) 2006-2008 by Marc Boris Duerner
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * As a special exception, you may use this file as part of a free
10 * software library without restriction. Specifically, if other files
11 * instantiate templates or use macros or inline functions from this
12 * file, or you compile this file and link it with other files to
13 * produce an executable, this file does not by itself cause the
14 * resulting executable to be covered by the GNU General Public
15 * License. This exception does not however invalidate any other
16 * reasons why the executable file might be covered by the GNU Library
17 * General Public License.
18 *
19 * This library 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 GNU
22 * Lesser General Public License for more details.
23 *
24 * You should have received a copy of the GNU Lesser General Public
25 * License along with this library; if not, write to the Free Software
26 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
27 */
28
29#ifndef PT_SYSTEM_CONDITION_H
30#define PT_SYSTEM_CONDITION_H
31
32#include <Pt/System/Api.h>
33#include <Pt/System/Mutex.h>
34#include <Pt/NonCopyable.h>
35#include <cstddef>
36
37namespace Pt {
38
39namespace System {
40
50 class PT_SYSTEM_API Condition : private NonCopyable
51 {
52 public:
55
58
61 void wait(Mutex& mtx);
62
69 void wait(MutexLock& m)
70 { this->wait( m.mutex() ); }
71
76 bool wait(Mutex& mtx, unsigned int ms);
77
85 bool wait( MutexLock& m, unsigned int ms)
86 { return this->wait( m.mutex(), ms ); }
87
89 void signal();
90
92 void broadcast();
93
94 private:
95 class ConditionImpl* _impl;
96 };
97
98} // namespace System
99
100} // namespace Pt
101
102#endif // PT_SYSTEM_CONDITION_H
NonCopyable()
Default constructor.
Definition NonCopyable.h:63
void wait(Mutex &mtx)
Wait until the condition is signaled.
Condition()
Default Constructor.
void broadcast()
Unblock all blocked threads.
void signal()
Unblock a single blocked thread.
~Condition()
Destructor.
bool wait(Mutex &mtx, unsigned int ms)
Wait until the condition is signaled or ms elapses.
void wait(MutexLock &m)
Wait until condition becomes signaled.
Definition Condition.h:69
bool wait(MutexLock &m, unsigned int ms)
Wait until condition becomes signalled.
Definition Condition.h:85
Scoped lock for a Mutex.
Definition Mutex.h:127
Mutex & mutex()
Returns the guarded the mutex object.
Definition Mutex.h:173
Mutual exclusion device.
Definition Mutex.h:73
System programming
Definition Connection.h:26
Core module.
Definition Allocator.h:33