Thread.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2005, Vintela, Inc. All rights reserved.
* Copyright (C) 2006, Novell, 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 Novell, Inc., 
*       nor the names of its contributors or employees 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 THE COPYRIGHT OWNER OR 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 BLOCXX_THREAD_HPP_INCLUDE_GUARD_
#define BLOCXX_THREAD_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/Exception.hpp"
#include "blocxx/String.hpp"
#include "blocxx/ThreadImpl.hpp"
#include "blocxx/IntrusiveReference.hpp"
#include "blocxx/IntrusiveCountableBase.hpp"
#include "blocxx/Assertion.hpp"
#include "blocxx/Condition.hpp"
#include "blocxx/NonRecursiveMutex.hpp"
#include "blocxx/ThreadDoneCallback.hpp"
#include "blocxx/ThreadCancelledException.hpp"
#include "blocxx/Timeout.hpp"
#include "blocxx/AtomicOps.hpp"

namespace BLOCXX_NAMESPACE
{

BLOCXX_DECLARE_APIEXCEPTION(CancellationDenied, BLOCXX_COMMON_API);
BLOCXX_DECLARE_APIEXCEPTION(Thread, BLOCXX_COMMON_API);

class BLOCXX_COMMON_API Thread : public IntrusiveCountableBase
{
public:
   Thread();
   virtual ~Thread();
   virtual void start(const ThreadDoneCallbackRef& cb = ThreadDoneCallbackRef(0));

   void shutdown();
   
   bool shutdown(const Timeout& timeout);

   void cooperativeCancel();

   bool definitiveCancel(const Timeout& timeout = Timeout::relative(60));
   bool definitiveCancel(UInt32 waitForCooperativeSecs) BLOCXX_DEPRECATED; // in 4.0.0
   void cancel();
   static void testCancel();
private:

   void cancel_internal(bool is_locked);

   virtual void doShutdown();

   virtual void doCooperativeCancel();

   virtual void doDefinitiveCancel();
public:
   bool isRunning()
   {
      return m_isRunning == true;
   }
   bool timedWait(const Timeout& timeout);
   Int32 join();
   Thread_t getId()
   {
      return m_id;
   }
   static void sleep(UInt32 milliSeconds)
   {
      ThreadImpl::sleep(milliSeconds);
   }
   static void sleep(const Timeout& timeout)
   {
      ThreadImpl::sleep(timeout);
   }
   static void yield()
   {
      ThreadImpl::yield();
   }
private:
   virtual Int32 run() = 0;
   // thread state
   Thread_t m_id;
   bool m_isRunning;
   bool m_joined;
   // used to implement cancellation.
   friend void ThreadImpl::testCancel();
   Atomic_t m_cancelRequested;
   bool m_cancelled;

   NonRecursiveMutex m_stateGuard;
   Condition m_stateCond;

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

} // end namespace BLOCXX_NAMESPACE

#endif