blocxx
Condition.hpp
Go to the documentation of this file.
1/*******************************************************************************
2* Copyright (C) 2005, Vintela, Inc. All rights reserved.
3* Copyright (C) 2006, Novell, Inc. All rights reserved.
4*
5* Redistribution and use in source and binary forms, with or without
6* modification, are permitted provided that the following conditions are met:
7*
8* * Redistributions of source code must retain the above copyright notice,
9* this list of conditions and the following disclaimer.
10* * Redistributions in binary form must reproduce the above copyright
11* notice, this list of conditions and the following disclaimer in the
12* documentation and/or other materials provided with the distribution.
13* * Neither the name of
14* Vintela, Inc.,
15* nor Novell, Inc.,
16* nor the names of its contributors or employees may be used to
17* endorse or promote products derived from this software without
18* specific prior written permission.
19*
20* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
24* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30* POSSIBILITY OF SUCH DAMAGE.
31*******************************************************************************/
32
33
38#ifndef BLOCXX_CONDITION_HPP_INCLUDE_GUARD_
39#define BLOCXX_CONDITION_HPP_INCLUDE_GUARD_
40#include "blocxx/BLOCXX_config.h"
42#include "blocxx/Exception.hpp"
43#include "blocxx/Types.hpp"
44#include "blocxx/CommonFwd.hpp"
45
46namespace BLOCXX_NAMESPACE
47{
48
49BLOCXX_DECLARE_APIEXCEPTION(ConditionLock, BLOCXX_COMMON_API);
50BLOCXX_DECLARE_APIEXCEPTION(ConditionResource, BLOCXX_COMMON_API);
51
62class BLOCXX_COMMON_API Condition
63{
64public:
70
81 void notifyOne();
88 void notifyAll();
101 void wait(NonRecursiveMutexLock& lock);
102
120 bool timedWait(NonRecursiveMutexLock& lock, const Timeout& timeout);
121
143 bool timedWait(NonRecursiveMutexLock& lock, UInt32 sTimeout, UInt32 usTimeout=0) BLOCXX_DEPRECATED;
144private:
145 // unimplemented
147 Condition& operator=(const Condition&);
148 void doWait(NonRecursiveMutex& mutex);
149 bool doTimedWait(NonRecursiveMutex& mutex, const Timeout& timeout);
150 ConditionVar_t m_condition;
151};
152
153} // end namespace BLOCXX_NAMESPACE
154
155#endif
#define BLOCXX_DECLARE_APIEXCEPTION(NAME, LINKAGE_SPEC)
Declare a new exception class named <NAME>Exception that derives from Exception This macro is typical...
The Condition class represents a synchronization device that allows threads to suspend execution and ...
Definition Condition.hpp:63
~Condition()
Destroy this Condition object.
void notifyAll()
Signal all threads that are currently waiting on the Condition object.
Condition()
Construct a new Condition object.
void notifyOne()
Signal one thread that is currently waiting on the Condition object through the wait or timedWait met...
Note that descriptions of what exceptions may be thrown assumes that object is used correctly,...
Note that descriptions of what exceptions may be thrown assumes that object is used correctly,...
A timeout can be absolute, which means that it will happen at the specified DateTime.
Definition Timeout.hpp:56
Taken from RFC 1321.