OW_Thread.hpp

Go to the documentation of this file.
00001 /*******************************************************************************
00002 * Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
00003 *
00004 * Redistribution and use in source and binary forms, with or without
00005 * modification, are permitted provided that the following conditions are met:
00006 *
00007 *  - Redistributions of source code must retain the above copyright notice,
00008 *    this list of conditions and the following disclaimer.
00009 *
00010 *  - Redistributions in binary form must reproduce the above copyright notice,
00011 *    this list of conditions and the following disclaimer in the documentation
00012 *    and/or other materials provided with the distribution.
00013 *
00014 *  - Neither the name of Vintela, Inc. nor the names of its
00015 *    contributors may be used to endorse or promote products derived from this
00016 *    software without specific prior written permission.
00017 *
00018 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
00019 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00020 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00021 * ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
00022 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00023 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00024 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00025 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00026 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00027 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00028 * POSSIBILITY OF SUCH DAMAGE.
00029 *******************************************************************************/
00030 
00036 #ifndef OW_THREAD_HPP_INCLUDE_GUARD_
00037 #define OW_THREAD_HPP_INCLUDE_GUARD_
00038 #include "OW_config.h"
00039 #include "OW_Exception.hpp"
00040 #include "OW_String.hpp"
00041 #include "OW_ThreadImpl.hpp"
00042 #include "OW_IntrusiveReference.hpp"
00043 #include "OW_IntrusiveCountableBase.hpp"
00044 #include "OW_Assertion.hpp"
00045 #include "OW_Condition.hpp"
00046 #include "OW_NonRecursiveMutex.hpp"
00047 #include "OW_ThreadDoneCallback.hpp"
00048 #include "OW_ThreadCancelledException.hpp"
00049 
00050 namespace OW_NAMESPACE
00051 {
00052 
00054 OW_DECLARE_APIEXCEPTION(CancellationDenied, OW_COMMON_API);
00055 OW_DECLARE_APIEXCEPTION(Thread, OW_COMMON_API);
00057 class OW_COMMON_API Thread : public IntrusiveCountableBase
00058 {
00059 public:
00063    Thread();
00069    virtual ~Thread();
00074    virtual void start(const ThreadDoneCallbackRef& cb = ThreadDoneCallbackRef(0));
00093    void cooperativeCancel();
00129    bool definitiveCancel(UInt32 waitForCooperativeSecs = 60);
00149    void cancel();
00178    static void testCancel();
00179 private:
00197    virtual void doCooperativeCancel();
00205    virtual void doDefinitiveCancel();
00206 public:
00210    bool isRunning()
00211    {
00212       return m_isRunning == true;
00213    }
00225    Int32 join();
00235    Thread_t getId()
00236    {
00237       return m_id;
00238    }
00244    static void sleep(UInt32 milliSeconds)
00245    {
00246       ThreadImpl::sleep(milliSeconds);
00247    }
00252    static void yield()
00253    {
00254       ThreadImpl::yield();
00255    }
00256 private:
00260    virtual Int32 run() = 0;
00261    // thread state
00262    Thread_t m_id;
00263    bool m_isRunning;
00264    bool m_isStarting;
00265    bool m_joined;
00266    // used to implement cancellation.
00267    friend void ThreadImpl::testCancel();
00268    NonRecursiveMutex m_cancelLock;
00269    Condition m_cancelCond;
00270    bool m_cancelRequested;
00271    bool m_cancelled;
00272 
00273    static Int32 threadRunner(void* paramPtr);
00274    void doneRunning(const ThreadDoneCallbackRef& cb);
00275    
00276    // non-copyable
00277    Thread(const Thread&);
00278    Thread& operator=(const Thread&);
00279    
00280 };
00281 OW_EXPORT_TEMPLATE(OW_COMMON_API, IntrusiveReference, Thread);
00282 
00283 } // end namespace OW_NAMESPACE
00284 
00285 #endif
00286 

Generated on Thu Feb 9 08:48:17 2006 for openwbem by  doxygen 1.4.6