ThreadImpl.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_THREADIMPL_HPP_INCLUDE_GUARD_
#define BLOCXX_THREADIMPL_HPP_INCLUDE_GUARD_
#include "blocxx/BLOCXX_config.h"
#include "blocxx/Types.hpp"
#include "blocxx/ThreadTypes.hpp"
#include "blocxx/Timeout.hpp"

#ifdef BLOCXX_NCR
#ifndef PTHREAD_ONCE_INIT
#define PTHREAD_ONCE_INIT pthread_once_init
#endif
#endif


// The classes and functions defined in this file are not meant for general
// use, they are internal implementation details.  They may change at any time.

namespace BLOCXX_NAMESPACE
{

/*----------------------------------
 * Definitions to support threading.
 -----------------------------------*/
#define BLOCXX_THREAD_FLG_JOINABLE 0x000000001
typedef Int32 (*ThreadFunction)(void*);
namespace ThreadImpl
{
   BLOCXX_COMMON_API int createThread(Thread_t& handle, ThreadFunction func,
      void* funcParm, UInt32 threadFlags);
   BLOCXX_COMMON_API void destroyThread(Thread_t& handle);
   inline bool sameThreads(const volatile Thread_t& handle1,
      const volatile Thread_t& handle2)
   {
   #if defined(BLOCXX_WIN32)
      return handle1 == handle2;
   #elif BLOCXX_USE_PTHREAD
      return pthread_equal(handle1, handle2);
   #endif
   }
   BLOCXX_COMMON_API void exitThread(Thread_t& handle, Int32 rval);
   inline Thread_t currentThread()
   {
#if defined(BLOCXX_WIN32)
      return GetCurrentThreadId();
#else
      return pthread_self();
#endif
   }


   BLOCXX_COMMON_API UInt64 thread_t_ToUInt64(Thread_t thr);

   BLOCXX_COMMON_API int setThreadDetached(Thread_t& handle);
   BLOCXX_COMMON_API int joinThread(Thread_t& handle, Int32& rval);
   BLOCXX_COMMON_API void yield();
   BLOCXX_COMMON_API void sleep(UInt32 milliSeconds);
   BLOCXX_COMMON_API void sleep(const Timeout& timeout);
   BLOCXX_COMMON_API void testCancel();
   BLOCXX_COMMON_API void saveThreadInTLS(void* pTheThread);
   BLOCXX_COMMON_API void sendSignalToThread(Thread_t threadID, int signo);
   BLOCXX_COMMON_API void cancel(Thread_t threadID);
};

} // end namespace BLOCXX_NAMESPACE

#endif