Mercurial > sdl-ios-xcode
diff include/SDL_mutex.h @ 1895:c121d94672cb
SDL 1.2 is moving to a branch, and SDL 1.3 is becoming the head.
author | Sam Lantinga <slouken@libsdl.org> |
---|---|
date | Mon, 10 Jul 2006 21:04:37 +0000 |
parents | c71e05b4dc2e |
children | 99210400e8b9 |
line wrap: on
line diff
--- a/include/SDL_mutex.h Thu Jul 06 18:01:37 2006 +0000 +++ b/include/SDL_mutex.h Mon Jul 10 21:04:37 2006 +0000 @@ -23,10 +23,11 @@ #ifndef _SDL_mutex_h #define _SDL_mutex_h -/* Functions to provide thread synchronization primitives - - These are independent of the other SDL routines. -*/ +/** + * \file SDL_mutex.h + * + * Functions to provide thread synchronization primitives + */ #include "SDL_stdinc.h" #include "SDL_error.h" @@ -34,7 +35,9 @@ #include "begin_code.h" /* Set up for C function definitions, even when using C++ */ #ifdef __cplusplus +/* *INDENT-OFF* */ extern "C" { +/* *INDENT-ON* */ #endif /* Synchronization functions which can time out return this value @@ -55,21 +58,21 @@ typedef struct SDL_mutex SDL_mutex; /* Create a mutex, initialized unlocked */ -extern DECLSPEC SDL_mutex * SDLCALL SDL_CreateMutex(void); +extern DECLSPEC SDL_mutex *SDLCALL SDL_CreateMutex(void); /* Lock the mutex (Returns 0, or -1 on error) */ #define SDL_LockMutex(m) SDL_mutexP(m) -extern DECLSPEC int SDLCALL SDL_mutexP(SDL_mutex *mutex); +extern DECLSPEC int SDLCALL SDL_mutexP(SDL_mutex * mutex); /* Unlock the mutex (Returns 0, or -1 on error) It is an error to unlock a mutex that has not been locked by the current thread, and doing so results in undefined behavior. */ #define SDL_UnlockMutex(m) SDL_mutexV(m) -extern DECLSPEC int SDLCALL SDL_mutexV(SDL_mutex *mutex); +extern DECLSPEC int SDLCALL SDL_mutexV(SDL_mutex * mutex); /* Destroy a mutex */ -extern DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_mutex *mutex); +extern DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_mutex * mutex); /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ @@ -81,21 +84,21 @@ typedef struct SDL_semaphore SDL_sem; /* Create a semaphore, initialized with value, returns NULL on failure. */ -extern DECLSPEC SDL_sem * SDLCALL SDL_CreateSemaphore(Uint32 initial_value); +extern DECLSPEC SDL_sem *SDLCALL SDL_CreateSemaphore(Uint32 initial_value); /* Destroy a semaphore */ -extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem *sem); +extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem * sem); /* This function suspends the calling thread until the semaphore pointed * to by sem has a positive count. It then atomically decreases the semaphore * count. */ -extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem *sem); +extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem * sem); /* Non-blocking variant of SDL_SemWait(), returns 0 if the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait would block, and -1 on error. */ -extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem *sem); +extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem * sem); /* Variant of SDL_SemWait() with a timeout in milliseconds, returns 0 if the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in @@ -103,15 +106,15 @@ On some platforms this function is implemented by looping with a delay of 1 ms, and so should be avoided if possible. */ -extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem *sem, Uint32 ms); +extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem * sem, Uint32 ms); /* Atomically increases the semaphore's count (not blocking), returns 0, or -1 on error. */ -extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem *sem); +extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem * sem); /* Returns the current count of the semaphore */ -extern DECLSPEC Uint32 SDLCALL SDL_SemValue(SDL_sem *sem); +extern DECLSPEC Uint32 SDLCALL SDL_SemValue(SDL_sem * sem); /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ @@ -123,27 +126,27 @@ typedef struct SDL_cond SDL_cond; /* Create a condition variable */ -extern DECLSPEC SDL_cond * SDLCALL SDL_CreateCond(void); +extern DECLSPEC SDL_cond *SDLCALL SDL_CreateCond(void); /* Destroy a condition variable */ -extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond *cond); +extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond * cond); /* Restart one of the threads that are waiting on the condition variable, returns 0 or -1 on error. */ -extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond *cond); +extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond * cond); /* Restart all threads that are waiting on the condition variable, returns 0 or -1 on error. */ -extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond *cond); +extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond * cond); /* Wait on the condition variable, unlocking the provided mutex. The mutex must be locked before entering this function! The mutex is re-locked once the condition variable is signaled. Returns 0 when it is signaled, or -1 on error. */ -extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond *cond, SDL_mutex *mut); +extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond * cond, SDL_mutex * mut); /* Waits for at most 'ms' milliseconds, and returns 0 if the condition variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not @@ -151,12 +154,17 @@ On some platforms this function is implemented by looping with a delay of 1 ms, and so should be avoided if possible. */ -extern DECLSPEC int SDLCALL SDL_CondWaitTimeout(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms); +extern DECLSPEC int SDLCALL SDL_CondWaitTimeout(SDL_cond * cond, + SDL_mutex * mutex, Uint32 ms); /* Ends C function definitions when using C++ */ #ifdef __cplusplus +/* *INDENT-OFF* */ } +/* *INDENT-ON* */ #endif #include "close_code.h" #endif /* _SDL_mutex_h */ + +/* vi: set ts=4 sw=4 expandtab: */