thread.h

Go to the documentation of this file.

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
 
 
#ifndef INCLUDED_OSL_THREAD_H
#define INCLUDED_OSL_THREAD_H
 
#include "sal/config.h"
 
#include "osl/time.h"
#include "rtl/textenc.h"
#include "sal/saldllapi.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef void* oslThread;
 
typedef void (SAL_CALL *oslWorkerFunction)(void*);
 
typedef enum
{
    osl_Thread_PriorityHighest,
    osl_Thread_PriorityAboveNormal,
    osl_Thread_PriorityNormal,
    osl_Thread_PriorityBelowNormal,
    osl_Thread_PriorityLowest,
    osl_Thread_PriorityUnknown,         /* don't use to set */
    osl_Thread_Priority_FORCE_EQUAL_SIZE = SAL_MAX_ENUM
} oslThreadPriority;
 
 
typedef sal_uInt32 oslThreadIdentifier;
 
typedef void* oslThreadKey;
 
SAL_DLLPUBLIC oslThread SAL_CALL osl_createThread(oslWorkerFunction pWorker, void* pThreadData);
 
SAL_DLLPUBLIC oslThread SAL_CALL osl_createSuspendedThread(oslWorkerFunction pWorker, void* pThreadData);
 
SAL_DLLPUBLIC oslThreadIdentifier SAL_CALL osl_getThreadIdentifier(oslThread Thread);
 
SAL_DLLPUBLIC void SAL_CALL osl_destroyThread(oslThread Thread);
 
SAL_DLLPUBLIC void SAL_CALL osl_resumeThread(oslThread Thread);
 
SAL_DLLPUBLIC void SAL_CALL osl_suspendThread(oslThread Thread);
 
SAL_DLLPUBLIC void SAL_CALL osl_setThreadPriority(oslThread Thread, oslThreadPriority Priority);
 
SAL_DLLPUBLIC oslThreadPriority SAL_CALL osl_getThreadPriority(const oslThread Thread);
 
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_isThreadRunning(const oslThread Thread);
 
SAL_DLLPUBLIC void SAL_CALL osl_joinWithThread(oslThread Thread);
 
SAL_DLLPUBLIC void SAL_CALL osl_waitThread(const TimeValue* pDelay);
 
SAL_DLLPUBLIC void SAL_CALL osl_terminateThread(oslThread Thread);
 
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_scheduleThread(oslThread Thread);
 
SAL_DLLPUBLIC void SAL_CALL osl_yieldThread(void);
 
SAL_DLLPUBLIC void SAL_CALL osl_setThreadName(char const * name);
 
/* Callback when data stored in a thread key is no longer needed */
 
typedef void (SAL_CALL *oslThreadKeyCallbackFunction)(void *);
 
SAL_DLLPUBLIC oslThreadKey SAL_CALL osl_createThreadKey(oslThreadKeyCallbackFunction pCallback);
 
SAL_DLLPUBLIC void SAL_CALL osl_destroyThreadKey(oslThreadKey Key);
 
SAL_DLLPUBLIC void* SAL_CALL osl_getThreadKeyData(oslThreadKey Key);
 
SAL_DLLPUBLIC sal_Bool SAL_CALL osl_setThreadKeyData(oslThreadKey Key, void *pData);
 
SAL_DLLPUBLIC rtl_TextEncoding SAL_CALL osl_getThreadTextEncoding(void);
 
SAL_DLLPUBLIC rtl_TextEncoding SAL_CALL osl_setThreadTextEncoding(rtl_TextEncoding Encoding);
 
#ifdef __cplusplus
}
#endif
 
#endif // INCLUDED_OSL_THREAD_H
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */