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 
37 namespace Pt {
38 
39 namespace System {
40 
43  class PT_SYSTEM_API Condition : private NonCopyable
44  {
45  public:
47  Condition();
48 
50  ~Condition();
51 
52  void wait(Mutex& mtx);
53 
60  void wait(MutexLock& m)
61  { this->wait( m.mutex() ); }
62 
63  bool wait(Mutex& mtx, unsigned int ms);
64 
72  bool wait( MutexLock& m, unsigned int ms)
73  { return this->wait( m.mutex(), ms ); }
74 
76  void signal();
77 
79  void broadcast();
80 
81  private:
82  class ConditionImpl* _impl;
83  };
84 
85 } // namespace System
86 
87 } // namespace Pt
88 
89 #endif // PT_SYSTEM_CONDITION_H
Signal and wait synchronisation promitive.
Definition: Condition.h:43
Protects derived classes from being copied.
Definition: NonCopyable.h:54
bool wait(MutexLock &m, unsigned int ms)
Wait until condition becomes signalled.
Definition: Condition.h:72
Mutual exclusion device.
Definition: Mutex.h:48
Mutex & mutex()
Returns the guarded the mutex object.
Definition: Mutex.h:173
MutexLock class for Mutex.
Definition: Mutex.h:126
void wait(MutexLock &m)
Wait until condition becomes signaled.
Definition: Condition.h:60