OW_Thread.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_THREAD_HPP_INCLUDE_GUARD_
#define OW_THREAD_HPP_INCLUDE_GUARD_
#include "OW_config.h"
#include "OW_Exception.hpp"
#include "OW_String.hpp"
#include "OW_ThreadImpl.hpp"
#include "OW_IntrusiveReference.hpp"
#include "OW_IntrusiveCountableBase.hpp"
#include "OW_Assertion.hpp"
#include "OW_Condition.hpp"
#include "OW_NonRecursiveMutex.hpp"
#include "OW_ThreadDoneCallback.hpp"
#include "OW_ThreadCancelledException.hpp"

namespace OW_NAMESPACE
{

OW_DECLARE_APIEXCEPTION(CancellationDenied, OW_COMMON_API);
OW_DECLARE_APIEXCEPTION(Thread, OW_COMMON_API);
class OW_COMMON_API Thread : public IntrusiveCountableBase
{
public:
   Thread();
   virtual ~Thread();
   virtual void start(const ThreadDoneCallbackRef& cb = ThreadDoneCallbackRef(0));
   void cooperativeCancel();
   bool definitiveCancel(UInt32 waitForCooperativeSecs = 60);
   void cancel();
   static void testCancel();
private:
   virtual void doCooperativeCancel();
   virtual void doDefinitiveCancel();
public:
   bool isRunning()
   {
      return m_isRunning == true;
   }
   Int32 join();
   Thread_t getId()
   {
      return m_id;
   }
   static void sleep(UInt32 milliSeconds)
   {
      ThreadImpl::sleep(milliSeconds);
   }
   static void yield()
   {
      ThreadImpl::yield();
   }
private:
   virtual Int32 run() = 0;
   // thread state
   Thread_t m_id;
   bool m_isRunning;
   bool m_isStarting;
   bool m_joined;
   // used to implement cancellation.
   friend void ThreadImpl::testCancel();
   NonRecursiveMutex m_cancelLock;
   Condition m_cancelCond;
   bool m_cancelRequested;
   bool m_cancelled;

   static Int32 threadRunner(void* paramPtr);
   void doneRunning(const ThreadDoneCallbackRef& cb);
   
   // non-copyable
   Thread(const Thread&);
   Thread& operator=(const Thread&);
   
};
OW_EXPORT_TEMPLATE(OW_COMMON_API, IntrusiveReference, Thread);

} // end namespace OW_NAMESPACE

#endif

---