blocxx

ThreadImpl.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 
00039 #ifndef BLOCXX_THREADIMPL_HPP_INCLUDE_GUARD_
00040 #define BLOCXX_THREADIMPL_HPP_INCLUDE_GUARD_
00041 #include "blocxx/BLOCXX_config.h"
00042 #include "blocxx/Types.hpp"
00043 #include "blocxx/ThreadTypes.hpp"
00044 #include "blocxx/Timeout.hpp"
00045 
00046 #ifdef BLOCXX_NCR
00047 #ifndef PTHREAD_ONCE_INIT
00048 #define PTHREAD_ONCE_INIT pthread_once_init
00049 #endif
00050 #endif
00051 
00052 
00053 // The classes and functions defined in this file are not meant for general
00054 // use, they are internal implementation details.  They may change at any time.
00055 
00056 namespace BLOCXX_NAMESPACE
00057 {
00058 
00059 /*----------------------------------
00060  * Definitions to support threading.
00061  -----------------------------------*/
00062 #define BLOCXX_THREAD_FLG_JOINABLE 0x000000001
00063 typedef Int32 (*ThreadFunction)(void*);
00070 namespace ThreadImpl
00071 {
00083    BLOCXX_COMMON_API int createThread(Thread_t& handle, ThreadFunction func,
00084       void* funcParm, UInt32 threadFlags);
00090    BLOCXX_COMMON_API void destroyThread(Thread_t& handle);
00097    inline bool sameThreads(const volatile Thread_t& handle1,
00098       const volatile Thread_t& handle2)
00099    {
00100    #if defined(BLOCXX_WIN32)
00101       return handle1 == handle2;
00102    #elif BLOCXX_USE_PTHREAD
00103       return pthread_equal(handle1, handle2);
00104    #endif
00105    }
00113    BLOCXX_COMMON_API void exitThread(Thread_t& handle, Int32 rval);
00117    inline Thread_t currentThread()
00118    {
00119 #if defined(BLOCXX_WIN32)
00120       return GetCurrentThreadId();
00121 #else
00122       return pthread_self();
00123 #endif
00124    }
00125 
00126 
00135    BLOCXX_COMMON_API UInt64 thread_t_ToUInt64(Thread_t thr);
00136 
00145    BLOCXX_COMMON_API int setThreadDetached(Thread_t& handle);
00154    BLOCXX_COMMON_API int joinThread(Thread_t& handle, Int32& rval);
00159    BLOCXX_COMMON_API void yield();
00165    BLOCXX_COMMON_API void sleep(UInt32 milliSeconds);
00171    BLOCXX_COMMON_API void sleep(const Timeout& timeout);
00199    BLOCXX_COMMON_API void testCancel();
00200    BLOCXX_COMMON_API void saveThreadInTLS(void* pTheThread);
00201    BLOCXX_COMMON_API void sendSignalToThread(Thread_t threadID, int signo);
00202    BLOCXX_COMMON_API void cancel(Thread_t threadID);
00203 };
00204 
00205 } // end namespace BLOCXX_NAMESPACE
00206 
00207 #endif