spThread.h

Go to the documentation of this file.

 
#ifndef __SPTHREAD_H
#define __SPTHREAD_H
 
#include <sp/spDefs.h>
 
#if defined(_WIN32) && !defined(HAVE_PTHREAD)
#if defined(USE_MOTIF) || defined(GTK)
#undef Status
#define INT32 wINT32
#define boolean wboolean
#endif
#include <windows.h>
#if defined(_MSC_VER)
#include <process.h>
#define HAVE_BEGINTHREADEX
#endif /* defined(_MSC_VER) */
#if defined(USE_MOTIF) || defined(USE_GTK)
#define Status int
#undef INT32
#undef boolean
#endif
#elif defined(MACOS) && !defined(MACOSX)
#include <Threads.h>
#elif defined(MACOSX) || defined(HAVE_PTHREAD)
#include <pthread.h>
#endif
 
#ifdef __cplusplus
extern "C" {
#endif
 
  /*----@addtogroup spThreadGroup----*/
 
#define SP_THREAD_PRIORITY_TIME_CRITICAL 15     
#define SP_THREAD_PRIORITY_HIGHEST 2            
#define SP_THREAD_PRIORITY_ABOVE_NORMAL 1       
#define SP_THREAD_PRIORITY_NORMAL 0             
#define SP_THREAD_PRIORITY_BELOW_NORMAL (-1)    
#define SP_THREAD_PRIORITY_LOWEST (-2)          
#define SP_THREAD_PRIORITY_IDLE (-15)           
#define SP_THREAD_EXIT_SUCCESS 0
#define SP_THREAD_EXIT_FAILURE -2
#define SP_THREAD_EXIT_CANCELED -1
 
#define SP_EVENT_TIMEOUT_INFINITE -1    
#define SP_EVENT_WAIT_FAILED -1         
#define SP_EVENT_WAIT_SIGNALED 0        
#define SP_EVENT_WAIT_TIMEOUT 1         
#define SP_EVENT_WAIT_ABANDONED 2       
typedef enum {
    SP_THREAD_LEVEL_LOW = 0,
    SP_THREAD_LEVEL_BELOW_MIDDLE = 25,
    SP_THREAD_LEVEL_MIDDLE = 50,
    SP_THREAD_LEVEL_ABOVE_MIDDLE = 75,
    SP_THREAD_LEVEL_HIGH = 100,
} spThreadLevel;
 
  /*----@addtogroup spThreadGroup----*/
 
#if defined(_WIN32) && !defined(HAVE_PTHREAD)
#if defined(HAVE_BEGINTHREADEX)
#define spThreadReturn unsigned __stdcall
typedef unsigned (__stdcall *spThreadFunc)(void *data);
#else
#define spThreadReturn DWORD WINAPI
typedef DWORD (WINAPI *spThreadFunc)(void *data);
#endif
 
#define SP_THREAD_RETURN_SUCCESS 0
#define SP_THREAD_RETURN_FAILURE 1
 
#define spThreadId DWORD
    
#else
#define spThreadReturn void *
typedef spThreadReturn (*spThreadFunc)(void *data);
 
#define SP_THREAD_RETURN_SUCCESS (void *)0
#define SP_THREAD_RETURN_FAILURE (void *)1
 
#if defined(MACOS) && !defined(MACOSX)
#define spThreadId ThreadID
#else
#define spThreadId pthread_t
#endif
    
#endif
 
typedef enum {
    SP_COMMAND_THREAD_STARTED = 0,      
    SP_COMMAND_THREAD_FINISHED = 1,     
    SP_COMMAND_THREAD_COMMAND_FINISHED = 2,     
    SP_COMMAND_THREAD_COMMAND_FAILED = 3,   
    SP_COMMAND_THREAD_COMMAND_WAIT_FAILED = 4,  
} spCommandThreadStatus;
 
typedef void (*spCommandThreadCallback)(spCommandThreadStatus status, long data, void *user_data);
 
    
#if defined(MACOS)
#pragma import on
extern int spGetNumCoopThreadMac(void);
#endif
 
extern void *spCreateThread(long stacksize, int priority, spThreadFunc func, void *data);
extern void spDestroyThread(void *handle);
extern void spExitThread(long status);
extern void spYieldThread(void);
extern long spWaitThread(void *handle);
    
extern spThreadId spGetThreadId(void *handle);
extern spThreadId spGetCurrentThreadId(void);
extern spBool spEqThreadId(spThreadId id1, spThreadId id2);
 
extern void *spCreateMutex(const char *name);
extern void spDestroyMutex(void *handle);
extern spBool spLockMutex(void *handle);
extern spBool spUnlockMutex(void *handle);
extern spBool spWaitMutex(void *handle);
 
extern void *spCreateEvent(spBool manual_reset, spBool initial_signal);
extern spBool spDestroyEvent(void *handle);
extern int spWaitEventTimeout(void *handle, long timeout_ms);
extern spBool spWaitEvent(void *handle);
extern spBool spSetEvent(void *handle);
extern spBool spResetEvent(void *handle);
extern spBool spPulseEvent(void *handle);
    
extern spBool spIsThreadLevelVariable(void);
extern spBool spIsLowLevelThreadUsed(void);
extern spBool spSetThreadLevel(spThreadLevel level);
extern spThreadLevel spGetThreadLevel(void);
    
extern spBool spCreateCommandThread(const char *command, spCommandThreadCallback func, void *data);
 
#if defined(MACOS)
#pragma import off
#endif
 
  /*----@addtogroup spThreadGroup----*/
 
#ifdef __cplusplus
}  /* Close scope of 'extern "C"' declaration */
#endif
 
#endif /* __SPTHREAD_H */