Mercurial > sdl-ios-xcode
annotate include/SDL_mutex.h @ 4281:6e3c19f8ab96 SDL-1.2
SDL 1.2.14 is a recommended update.
| author | Sam Lantinga <slouken@libsdl.org> |
|---|---|
| date | Wed, 07 Oct 2009 08:03:32 +0000 |
| parents | 4c4113c2162c |
| children |
| rev | line source |
|---|---|
| 0 | 1 /* |
| 2 SDL - Simple DirectMedia Layer | |
| 4159 | 3 Copyright (C) 1997-2009 Sam Lantinga |
| 0 | 4 |
| 5 This library is free software; you can redistribute it and/or | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1263
diff
changeset
|
6 modify it under the terms of the GNU Lesser General Public |
| 0 | 7 License as published by the Free Software Foundation; either |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1263
diff
changeset
|
8 version 2.1 of the License, or (at your option) any later version. |
| 0 | 9 |
| 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 | |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1263
diff
changeset
|
13 Lesser General Public License for more details. |
| 0 | 14 |
|
1312
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1263
diff
changeset
|
15 You should have received a copy of the GNU Lesser General Public |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1263
diff
changeset
|
16 License along with this library; if not, write to the Free Software |
|
c9b51268668f
Updated copyright information and removed rcs id lines (problematic in branch merges)
Sam Lantinga <slouken@libsdl.org>
parents:
1263
diff
changeset
|
17 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA |
| 0 | 18 |
| 19 Sam Lantinga | |
|
251
b8688cfdc232
Updated the headers with the correct e-mail address
Sam Lantinga <slouken@libsdl.org>
parents:
0
diff
changeset
|
20 slouken@libsdl.org |
| 0 | 21 */ |
| 22 | |
| 23 #ifndef _SDL_mutex_h | |
| 24 #define _SDL_mutex_h | |
| 25 | |
| 4217 | 26 /** @file SDL_mutex.h |
| 27 * Functions to provide thread synchronization primitives | |
| 28 * | |
| 29 * @note These are independent of the other SDL routines. | |
| 30 */ | |
| 0 | 31 |
|
1356
67114343400d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
1312
diff
changeset
|
32 #include "SDL_stdinc.h" |
|
1358
c71e05b4dc2e
More header massaging... works great on Windows. ;-)
Sam Lantinga <slouken@libsdl.org>
parents:
1356
diff
changeset
|
33 #include "SDL_error.h" |
| 0 | 34 |
| 35 #include "begin_code.h" | |
| 36 /* Set up for C function definitions, even when using C++ */ | |
| 37 #ifdef __cplusplus | |
| 38 extern "C" { | |
| 39 #endif | |
| 40 | |
| 4217 | 41 /** Synchronization functions which can time out return this value |
| 42 * if they time out. | |
| 43 */ | |
| 0 | 44 #define SDL_MUTEX_TIMEDOUT 1 |
| 45 | |
| 4217 | 46 /** This is the timeout value which corresponds to never time out */ |
| 0 | 47 #define SDL_MUTEX_MAXWAIT (~(Uint32)0) |
| 48 | |
| 49 | |
| 50 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
| 4217 | 51 /** @name Mutex functions */ /*@{*/ |
| 0 | 52 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ |
| 53 | |
| 4217 | 54 /** The SDL mutex structure, defined in SDL_mutex.c */ |
| 0 | 55 struct SDL_mutex; |
| 56 typedef struct SDL_mutex SDL_mutex; | |
| 57 | |
| 4217 | 58 /** Create a mutex, initialized unlocked */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
59 extern DECLSPEC SDL_mutex * SDLCALL SDL_CreateMutex(void); |
| 0 | 60 |
| 61 #define SDL_LockMutex(m) SDL_mutexP(m) | |
| 4217 | 62 /** Lock the mutex |
| 63 * @return 0, or -1 on error | |
| 64 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
65 extern DECLSPEC int SDLCALL SDL_mutexP(SDL_mutex *mutex); |
| 0 | 66 |
| 4217 | 67 #define SDL_UnlockMutex(m) SDL_mutexV(m) |
| 68 /** Unlock the mutex | |
| 69 * @return 0, or -1 on error | |
| 70 * | |
| 71 * It is an error to unlock a mutex that has not been locked by | |
| 72 * the current thread, and doing so results in undefined behavior. | |
|
417
04ec6995f75d
*** empty log message ***
Sam Lantinga <slouken@libsdl.org>
parents:
337
diff
changeset
|
73 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
74 extern DECLSPEC int SDLCALL SDL_mutexV(SDL_mutex *mutex); |
| 0 | 75 |
| 4217 | 76 /** Destroy a mutex */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
77 extern DECLSPEC void SDLCALL SDL_DestroyMutex(SDL_mutex *mutex); |
| 0 | 78 |
| 4217 | 79 /*@}*/ |
| 0 | 80 |
| 81 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
| 4217 | 82 /** @name Semaphore functions */ /*@{*/ |
| 0 | 83 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ |
| 84 | |
| 4217 | 85 /** The SDL semaphore structure, defined in SDL_sem.c */ |
| 0 | 86 struct SDL_semaphore; |
| 87 typedef struct SDL_semaphore SDL_sem; | |
| 88 | |
| 4217 | 89 /** Create a semaphore, initialized with value, returns NULL on failure. */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
90 extern DECLSPEC SDL_sem * SDLCALL SDL_CreateSemaphore(Uint32 initial_value); |
| 0 | 91 |
| 4217 | 92 /** Destroy a semaphore */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
93 extern DECLSPEC void SDLCALL SDL_DestroySemaphore(SDL_sem *sem); |
| 0 | 94 |
| 4217 | 95 /** |
| 96 * This function suspends the calling thread until the semaphore pointed | |
| 0 | 97 * to by sem has a positive count. It then atomically decreases the semaphore |
| 98 * count. | |
| 99 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
100 extern DECLSPEC int SDLCALL SDL_SemWait(SDL_sem *sem); |
| 0 | 101 |
| 4217 | 102 /** Non-blocking variant of SDL_SemWait(). |
| 103 * @return 0 if the wait succeeds, | |
| 104 * SDL_MUTEX_TIMEDOUT if the wait would block, and -1 on error. | |
| 105 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
106 extern DECLSPEC int SDLCALL SDL_SemTryWait(SDL_sem *sem); |
| 0 | 107 |
| 4217 | 108 /** Variant of SDL_SemWait() with a timeout in milliseconds, returns 0 if |
| 109 * the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in | |
| 110 * the allotted time, and -1 on error. | |
| 111 * | |
| 112 * On some platforms this function is implemented by looping with a delay | |
| 113 * of 1 ms, and so should be avoided if possible. | |
| 114 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
115 extern DECLSPEC int SDLCALL SDL_SemWaitTimeout(SDL_sem *sem, Uint32 ms); |
| 0 | 116 |
| 4217 | 117 /** Atomically increases the semaphore's count (not blocking). |
| 118 * @return 0, or -1 on error. | |
| 0 | 119 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
120 extern DECLSPEC int SDLCALL SDL_SemPost(SDL_sem *sem); |
| 0 | 121 |
| 4217 | 122 /** Returns the current count of the semaphore */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
123 extern DECLSPEC Uint32 SDLCALL SDL_SemValue(SDL_sem *sem); |
| 0 | 124 |
| 4217 | 125 /*@}*/ |
| 0 | 126 |
| 127 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ | |
| 4217 | 128 /** @name Condition_variable_functions */ /*@{*/ |
| 0 | 129 /* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */ |
| 130 | |
| 4217 | 131 /*@{*/ |
| 132 /** The SDL condition variable structure, defined in SDL_cond.c */ | |
| 0 | 133 struct SDL_cond; |
| 134 typedef struct SDL_cond SDL_cond; | |
| 4217 | 135 /*@}*/ |
| 0 | 136 |
| 4217 | 137 /** Create a condition variable */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
138 extern DECLSPEC SDL_cond * SDLCALL SDL_CreateCond(void); |
| 0 | 139 |
| 4217 | 140 /** Destroy a condition variable */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
141 extern DECLSPEC void SDLCALL SDL_DestroyCond(SDL_cond *cond); |
| 0 | 142 |
| 4217 | 143 /** Restart one of the threads that are waiting on the condition variable, |
| 144 * @return 0 or -1 on error. | |
| 0 | 145 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
146 extern DECLSPEC int SDLCALL SDL_CondSignal(SDL_cond *cond); |
| 0 | 147 |
| 4217 | 148 /** Restart all threads that are waiting on the condition variable, |
| 149 * @return 0 or -1 on error. | |
| 0 | 150 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
151 extern DECLSPEC int SDLCALL SDL_CondBroadcast(SDL_cond *cond); |
| 0 | 152 |
| 4217 | 153 /** Wait on the condition variable, unlocking the provided mutex. |
| 154 * The mutex must be locked before entering this function! | |
| 155 * The mutex is re-locked once the condition variable is signaled. | |
| 156 * @return 0 when it is signaled, or -1 on error. | |
| 0 | 157 */ |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
158 extern DECLSPEC int SDLCALL SDL_CondWait(SDL_cond *cond, SDL_mutex *mut); |
| 0 | 159 |
| 4217 | 160 /** Waits for at most 'ms' milliseconds, and returns 0 if the condition |
| 161 * variable is signaled, SDL_MUTEX_TIMEDOUT if the condition is not | |
| 162 * signaled in the allotted time, and -1 on error. | |
| 163 * On some platforms this function is implemented by looping with a delay | |
| 164 * of 1 ms, and so should be avoided if possible. | |
| 165 */ | |
|
337
9154ec9ca3d2
Explicitly specify the SDL API calling convention (C by default)
Sam Lantinga <slouken@libsdl.org>
parents:
297
diff
changeset
|
166 extern DECLSPEC int SDLCALL SDL_CondWaitTimeout(SDL_cond *cond, SDL_mutex *mutex, Uint32 ms); |
| 0 | 167 |
| 4217 | 168 /*@}*/ |
| 169 | |
| 0 | 170 /* Ends C function definitions when using C++ */ |
| 171 #ifdef __cplusplus | |
| 172 } | |
| 173 #endif | |
| 174 #include "close_code.h" | |
| 175 | |
| 176 #endif /* _SDL_mutex_h */ | |
| 4217 | 177 |