orxThread.h

Go to the documentation of this file.

/* Orx - Portable Game Engine
 *
 * Copyright (c) 2008-2020 Orx-Project
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 *    1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 *
 *    2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 *
 *    3. This notice may not be removed or altered from any source
 *    distribution.
 */

#ifndef _orxTHREAD_H_
#define _orxTHREAD_H_

#include "orxInclude.h"

#ifdef __orxWINDOWS__
  #include "memory/orxMemory.h"
#else /* __orxWINDOWS__ */
  #include <semaphore.h>
#endif /* __orxWINDOWS__ */


#define orxTHREAD_KU32_MAIN_THREAD_ID                 0           
#define orxTHREAD_KU32_MAX_THREAD_NUMBER              16          
#define orxTHREAD_KU32_FLAG_NONE                      0           
#define orxTHREAD_KU32_MASK_ALL                       (((1 << orxTHREAD_KU32_MAX_THREAD_NUMBER) - 1) & ~(1 << orxTHREAD_KU32_MAIN_THREAD_ID)) /* Mask all (for orxThread_Enable) */
#define orxTHREAD_GET_FLAG_FROM_ID(ID)                (1 << (ID)) 
typedef struct __orxTHREAD_SEMAPHORE_t                orxTHREAD_SEMAPHORE;


typedef orxSTATUS (orxFASTCALL *orxTHREAD_FUNCTION)(void *_pContext);


extern orxDLLAPI void orxFASTCALL                     orxThread_Setup();

extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_Init();

extern orxDLLAPI void orxFASTCALL                     orxThread_Exit();


extern orxDLLAPI orxU32 orxFASTCALL                   orxThread_Start(const orxTHREAD_FUNCTION _pfnRun, const orxSTRING _zName, void *_pContext);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_Join(orxU32 _u32ThreadID);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_JoinAll();

extern orxDLLAPI const orxSTRING orxFASTCALL          orxThread_GetName(orxU32 _u32ThreadID);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_Enable(orxU32 _u32EnableThreads, orxU32 _u32DisableThreads);

extern orxDLLAPI orxU32 orxFASTCALL                   orxThread_GetCurrent();

extern orxDLLAPI void orxFASTCALL                     orxThread_Yield();


extern orxDLLAPI orxTHREAD_SEMAPHORE *orxFASTCALL     orxThread_CreateSemaphore(orxU32 _u32Value);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_DeleteSemaphore(orxTHREAD_SEMAPHORE *_pstSemaphore);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_WaitSemaphore(orxTHREAD_SEMAPHORE *_pstSemaphore);

extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_SignalSemaphore(orxTHREAD_SEMAPHORE *_pstSemaphore);


extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_RunTask(const orxTHREAD_FUNCTION _pfnRun, const orxTHREAD_FUNCTION _pfnThen, const orxTHREAD_FUNCTION _pfnElse, void *_pContext);

extern orxDLLAPI orxU32 orxFASTCALL                   orxThread_GetTaskCount();

extern orxDLLAPI orxSTATUS orxFASTCALL                orxThread_SetCallbacks(const orxTHREAD_FUNCTION _pfnStart, const orxTHREAD_FUNCTION _pfnStop, void *_pContext);

#endif /* _orxTHREAD_H_ */