blocxx
Semaphore.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_SEMAPHORE_HPP_INCLUDE_GUARD_
39#define BLOCXX_SEMAPHORE_HPP_INCLUDE_GUARD_
40#include "blocxx/BLOCXX_config.h"
41#include "blocxx/Types.hpp"
43#include "blocxx/Condition.hpp"
45#include "blocxx/Timeout.hpp"
47
48namespace BLOCXX_NAMESPACE
49{
50// TODO: uninline this class.
52{
53public:
55 : m_curCount(0)
56 {}
57 Semaphore(Int32 initCount)
58 : m_curCount(initCount)
59 {}
60 void wait()
61 {
63 while (m_curCount <= 0)
64 {
65 m_cond.wait(l);
66 }
67 --m_curCount;
68 }
69 BLOCXX_DEPRECATED bool timedWait(UInt32 sTimeout, UInt32 usTimeout=0) // in 4.0.0
70 {
71 return timedWait(Timeout::relative(sTimeout + static_cast<float>(usTimeout) * 1000000.0));
72 }
73 bool timedWait(const Timeout& timeout)
74 {
75 bool ret = true;
77 TimeoutTimer timer(timeout);
78 while (m_curCount <= 0 && ret == true)
79 {
80 ret = m_cond.timedWait(l, timer.asAbsoluteTimeout());
81 }
82 if (ret == true)
83 {
84 --m_curCount;
85 }
86 return ret;
87 }
88 void signal()
89 {
91 ++m_curCount;
93 }
94 Int32 getCount()
95 {
97 return m_curCount;
98 }
99private:
103 // noncopyable
106};
107
108} // end namespace BLOCXX_NAMESPACE
109
110#endif
The Condition class represents a synchronization device that allows threads to suspend execution and ...
Definition Condition.hpp:63
void wait(NonRecursiveMutexLock &lock)
Atomically unlock a given mutex and wait for the this Condition object to get signalled.
void notifyAll()
Signal all threads that are currently waiting on the Condition object.
bool timedWait(NonRecursiveMutexLock &lock, const Timeout &timeout)
Atomically unlock a given mutex and wait for a given amount of time for this Condition object to get ...
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,...
Semaphore & operator=(const Semaphore &)
Semaphore(Int32 initCount)
Definition Semaphore.hpp:57
Semaphore(const Semaphore &)
NonRecursiveMutex m_mutex
bool timedWait(const Timeout &timeout)
Definition Semaphore.hpp:73
BLOCXX_DEPRECATED bool timedWait(UInt32 sTimeout, UInt32 usTimeout=0)
Definition Semaphore.hpp:69
A timeout can be absolute, which means that it will happen at the specified DateTime.
Definition Timeout.hpp:56
static Timeout relative(float seconds)
Definition Timeout.cpp:58
A TimeoutTimer is used by an algorithm to determine when a timeout has expired.
Timeout asAbsoluteTimeout() const
Converts the timer to an absolute timeout.
Taken from RFC 1321.