blocxx

Semaphore.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2005, Vintela, Inc. All rights reserved.
00003 * Copyright (C) 2006, Novell, Inc. All rights reserved.
00004 * 
00005 * Redistribution and use in source and binary forms, with or without
00006 * modification, are permitted provided that the following conditions are met:
00007 * 
00008 *     * Redistributions of source code must retain the above copyright notice,
00009 *       this list of conditions and the following disclaimer.
00010 *     * Redistributions in binary form must reproduce the above copyright
00011 *       notice, this list of conditions and the following disclaimer in the
00012 *       documentation and/or other materials provided with the distribution.
00013 *     * Neither the name of 
00014 *       Vintela, Inc., 
00015 *       nor Novell, Inc., 
00016 *       nor the names of its contributors or employees may be used to 
00017 *       endorse or promote products derived from this software without 
00018 *       specific prior written permission.
00019 * 
00020 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00021 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00022 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00023 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00024 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00025 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00026 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00027 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00028 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00029 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00030 * POSSIBILITY OF SUCH DAMAGE.
00031 *******************************************************************************/
00032 
00033 
00038 #ifndef BLOCXX_SEMAPHORE_HPP_INCLUDE_GUARD_
00039 #define BLOCXX_SEMAPHORE_HPP_INCLUDE_GUARD_
00040 #include "blocxx/BLOCXX_config.h"
00041 #include "blocxx/Types.hpp"
00042 #include "blocxx/NonRecursiveMutex.hpp"
00043 #include "blocxx/Condition.hpp"
00044 #include "blocxx/NonRecursiveMutexLock.hpp"
00045 #include "blocxx/Timeout.hpp"
00046 #include "blocxx/TimeoutTimer.hpp"
00047 
00048 namespace BLOCXX_NAMESPACE
00049 {
00050 // TODO: uninline this class.
00051 class Semaphore
00052 {
00053 public:
00054    Semaphore()
00055       : m_curCount(0)
00056    {}
00057    Semaphore(Int32 initCount)
00058       : m_curCount(initCount)
00059    {}
00060    void wait()
00061    {
00062       NonRecursiveMutexLock l(m_mutex);
00063       while (m_curCount <= 0)
00064       {
00065          m_cond.wait(l);
00066       }
00067       --m_curCount;
00068    }
00069    BLOCXX_DEPRECATED bool timedWait(UInt32 sTimeout, UInt32 usTimeout=0) // in 4.0.0
00070    {
00071       return timedWait(Timeout::relative(sTimeout + static_cast<float>(usTimeout) * 1000000.0));
00072    }
00073    bool timedWait(const Timeout& timeout)
00074    {
00075       bool ret = true;
00076       NonRecursiveMutexLock l(m_mutex);
00077       TimeoutTimer timer(timeout);
00078       while (m_curCount <= 0 && ret == true)
00079       {
00080          ret = m_cond.timedWait(l, timer.asAbsoluteTimeout());
00081       }
00082       if (ret == true)
00083       {
00084          --m_curCount;
00085       }
00086       return ret;
00087    }
00088    void signal()
00089    {
00090       NonRecursiveMutexLock l(m_mutex);
00091       ++m_curCount;
00092       m_cond.notifyAll();
00093    }
00094    Int32 getCount()
00095    {
00096       NonRecursiveMutexLock l(m_mutex);
00097       return m_curCount;
00098    }
00099 private:
00100    Int32 m_curCount;
00101    Condition m_cond;
00102    NonRecursiveMutex m_mutex;
00103    // noncopyable
00104    Semaphore(const Semaphore&);
00105    Semaphore& operator=(const Semaphore&);
00106 };
00107 
00108 } // end namespace BLOCXX_NAMESPACE
00109 
00110 #endif