2
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
5
This library is free software; you can redistribute it and/or
6
modify it under the terms of the GNU Lesser General Public
7
License as published by the Free Software Foundation; either
8
version 2.1 of the License, or (at your option) any later version.
10
This library is distributed in the hope that it will be useful,
11
but WITHOUT ANY WARRANTY; without even the implied warranty of
12
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
You should have received a copy of the GNU Lesser General Public
16
License along with this library; if not, write to the Free Software
17
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
26
/* Functions to provide thread synchronization primitives
28
These are independent of the other SDL routines.
31
#include "SDL_stdinc.h"
32
#include "SDL_error.h"
34
#include "begin_code.h"
35
/* Set up for C function definitions, even when using C++ */
40
/* Synchronization functions which can time out return this value
43
#define SDL_MUTEX_TIMEDOUT 1
45
/* This is the timeout value which corresponds to never time out */
46
#define SDL_MUTEX_MAXWAIT (~(Uint32)0)
49
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
51
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
53
/* The SDL mutex structure, defined in SDL_mutex.c */
55
typedef struct SDL_mutex SDL_mutex;
57
/* Create a mutex, initialized unlocked */
58
extern DECLSPEC SDL_mutex * SDLCALL SDL_CreateMutex(void);
60
/* Lock the mutex (Returns 0, or -1 on error) */
61
#define SDL_LockMutex(m) SDL_mutexP(m)
62
extern DECLSPEC int SDLCALL SDL_mutexP(SDL_mutex *mutex);
64
/* Unlock the mutex (Returns 0, or -1 on error)
65
It is an error to unlock a mutex that has not been locked by
66
the current thread, and doing so results in undefined behavior.
68
#define SDL_UnlockMutex(m) SDL_mutexV(m)
69
extern DECLSPEC int SDLCALL SDL_mutexV(SDL_mutex *mutex);
72
extern DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_mutex *mutex);
75
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
76
/* Semaphore functions */
77
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
79
/* The SDL semaphore structure, defined in SDL_sem.c */
81
typedef struct SDL_semaphore SDL_sem;
83
/* Create a semaphore, initialized with value, returns NULL on failure. */
84
extern DECLSPEC SDL_sem * SDLCALL SDL_CreateSemaphore(Uint32 initial_value);
86
/* Destroy a semaphore */
87
extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem *sem);
89
/* This function suspends the calling thread until the semaphore pointed
90
* to by sem has a positive count. It then atomically decreases the semaphore
93
extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem *sem);
95
/* Non-blocking variant of SDL_SemWait(), returns 0 if the wait succeeds,
96
SDL_MUTEX_TIMEDOUT if the wait would block, and -1 on error.
98
extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem *sem);
100
/* Variant of SDL_SemWait() with a timeout in milliseconds, returns 0 if
101
the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in
102
the allotted time, and -1 on error.
103
On some platforms this function is implemented by looping with a delay
104
of 1 ms, and so should be avoided if possible.
106
extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem *sem, Uint32 ms);
108
/* Atomically increases the semaphore's count (not blocking), returns 0,
111
extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem *sem);
113
/* Returns the current count of the semaphore */
114
extern DECLSPEC Uint32 SDLCALL SDL_SemValue(SDL_sem *sem);
117
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
118
/* Condition variable functions */
119
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
121
/* The SDL condition variable structure, defined in SDL_cond.c */
123
typedef struct SDL_cond SDL_cond;
125
/* Create a condition variable */
126
extern DECLSPEC SDL_cond * SDLCALL SDL_CreateCond(void);
128
/* Destroy a condition variable */
129
extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond *cond);
131
/* Restart one of the threads that are waiting on the condition variable,
132
returns 0 or -1 on error.
134
extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond *cond);
136
/* Restart all threads that are waiting on the condition variable,
137
returns 0 or -1 on error.
139
extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond *cond);
141
/* Wait on the condition variable, unlocking the provided mutex.
142
The mutex must be locked before entering this function!
143
The mutex is re-locked once the condition variable is signaled.
144
Returns 0 when it is signaled, or -1 on error.
146
extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond *cond, SDL_mutex *mut);
148
/* Waits for at most 'ms' milliseconds, and returns 0 if the condition
149
variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not
150
signaled in the allotted time, and -1 on error.
151
On some platforms this function is implemented by looping with a delay
152
of 1 ms, and so should be avoided if possible.
154
extern DECLSPEC int SDLCALL SDL_CondWaitTimeout(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms);
156
/* Ends C function definitions when using C++ */
160
#include "close_code.h"
162
#endif /* _SDL_mutex_h */
added
removed
source/include/SDL_mutex.h
