SDL_mutex.h
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2006 Sam Lantinga
4
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.
9
10
11
12
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13
Lesser General Public License for more details.
15
16
17
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
18
19
Sam Lantinga
20
slouken@libsdl.org
21
22
23
24
25
26
27
28
29
30
*/
#ifndef _SDL_mutex_h
#define _SDL_mutex_h
/* Functions to provide thread synchronization primitives
These are independent of the other SDL routines.
*/
31
#include "SDL_stdinc.h"
32
#include "SDL_error.h"
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
#include "begin_code.h"
/* Set up for C function definitions, even when using C++ */
#ifdef __cplusplus
extern "C" {
#endif
/* Synchronization functions which can time out return this value
if they time out.
*/
#define SDL_MUTEX_TIMEDOUT 1
/* This is the timeout value which corresponds to never time out */
#define SDL_MUTEX_MAXWAIT (~(Uint32)0)
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* Mutex functions */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* The SDL mutex structure, defined in SDL_mutex.c */
struct SDL_mutex;
typedef struct SDL_mutex SDL_mutex;
/* Create a mutex, initialized unlocked */
58
extern DECLSPEC SDL_mutex * SDLCALL SDL_CreateMutex(void);
59
60
61
/* Lock the mutex (Returns 0, or -1 on error) */
#define SDL_LockMutex(m) SDL_mutexP(m)
62
extern DECLSPEC int SDLCALL SDL_mutexP(SDL_mutex *mutex);
64
65
66
67
/* 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.
*/
68
#define SDL_UnlockMutex(m) SDL_mutexV(m)
69
extern DECLSPEC int SDLCALL SDL_mutexV(SDL_mutex *mutex);
70
71
/* Destroy a mutex */
72
extern DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_mutex *mutex);
73
74
75
76
77
78
79
80
81
82
83
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* Semaphore functions */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* The SDL semaphore structure, defined in SDL_sem.c */
struct SDL_semaphore;
typedef struct SDL_semaphore SDL_sem;
/* Create a semaphore, initialized with value, returns NULL on failure. */
84
extern DECLSPEC SDL_sem * SDLCALL SDL_CreateSemaphore(Uint32 initial_value);
85
86
/* Destroy a semaphore */
87
extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem *sem);
88
89
90
91
92
/* This function suspends the calling thread until the semaphore pointed
* to by sem has a positive count. It then atomically decreases the semaphore
* count.
*/
93
extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem *sem);
94
95
96
97
/* Non-blocking variant of SDL_SemWait(), returns 0 if the wait succeeds,
SDL_MUTEX_TIMEDOUT if the wait would block, and -1 on error.
*/
98
extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem *sem);
99
100
101
102
103
104
105
/* 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
the allotted time, and -1 on error.
On some platforms this function is implemented by looping with a delay
of 1 ms, and so should be avoided if possible.
*/
106
extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem *sem, Uint32 ms);
107
108
109
110
/* Atomically increases the semaphore's count (not blocking), returns 0,
or -1 on error.
*/
111
extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem *sem);
112
113
/* Returns the current count of the semaphore */
114
extern DECLSPEC Uint32 SDLCALL SDL_SemValue(SDL_sem *sem);
115
116
117
118
119
120
121
122
123
124
125
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* Condition variable functions */
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/* The SDL condition variable structure, defined in SDL_cond.c */
struct SDL_cond;
typedef struct SDL_cond SDL_cond;
/* Create a condition variable */
126
extern DECLSPEC SDL_cond * SDLCALL SDL_CreateCond(void);
127
128
/* Destroy a condition variable */
129
extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond *cond);
130
131
132
133
/* Restart one of the threads that are waiting on the condition variable,
returns 0 or -1 on error.
*/
134
extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond *cond);
135
136
137
138
/* Restart all threads that are waiting on the condition variable,
returns 0 or -1 on error.
*/
139
extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond *cond);
140
141
142
/* Wait on the condition variable, unlocking the provided mutex.
The mutex must be locked before entering this function!
143
The mutex is re-locked once the condition variable is signaled.
144
145
Returns 0 when it is signaled, or -1 on error.
*/
146
extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond *cond, SDL_mutex *mut);
147
148
149
150
151
152
153
/* Waits for at most 'ms' milliseconds, and returns 0 if the condition
variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not
signaled in the allotted time, and -1 on error.
On some platforms this function is implemented by looping with a delay
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);
155
156
157
158
159
160
161
162
/* Ends C function definitions when using C++ */
#ifdef __cplusplus
}
#endif
#include "close_code.h"
#endif /* _SDL_mutex_h */