blocxx

Condition.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_CONDITION_HPP_INCLUDE_GUARD_
00039 #define BLOCXX_CONDITION_HPP_INCLUDE_GUARD_
00040 #include "blocxx/BLOCXX_config.h"
00041 #include "blocxx/ThreadTypes.hpp"
00042 #include "blocxx/Exception.hpp"
00043 #include "blocxx/Types.hpp"
00044 #include "blocxx/CommonFwd.hpp"
00045 
00046 namespace BLOCXX_NAMESPACE
00047 {
00048 
00049 BLOCXX_DECLARE_APIEXCEPTION(ConditionLock, BLOCXX_COMMON_API);
00050 BLOCXX_DECLARE_APIEXCEPTION(ConditionResource, BLOCXX_COMMON_API);
00051 
00062 class BLOCXX_COMMON_API Condition
00063 {
00064 public:
00069    Condition();
00070 
00074    ~Condition();
00081    void notifyOne();
00088    void notifyAll();
00101    void wait(NonRecursiveMutexLock& lock);
00102 
00120    bool timedWait(NonRecursiveMutexLock& lock, const Timeout& timeout);
00121 
00143    bool timedWait(NonRecursiveMutexLock& lock, UInt32 sTimeout, UInt32 usTimeout=0) BLOCXX_DEPRECATED;
00144 private:
00145    // unimplemented
00146    Condition(const Condition&);
00147    Condition& operator=(const Condition&);
00148    void doWait(NonRecursiveMutex& mutex);
00149    bool doTimedWait(NonRecursiveMutex& mutex, const Timeout& timeout);
00150    ConditionVar_t m_condition;
00151 };
00152 
00153 } // end namespace BLOCXX_NAMESPACE
00154 
00155 #endif