This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
sdlsemtrywait.html
319 lines (316 loc) · 4.21 KB
1
2
3
4
5
6
<HTML
><HEAD
><TITLE
>SDL_SemTryWait</TITLE
><META
NAME="GENERATOR"
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
"><LINK
REL="HOME"
TITLE="SDL Library Documentation"
HREF="index.html"><LINK
REL="UP"
TITLE="Multi-threaded Programming"
HREF="thread.html"><LINK
REL="PREVIOUS"
TITLE="SDL_SemWait"
HREF="sdlsemwait.html"><LINK
REL="NEXT"
TITLE="SDL_SemWaitTimeout"
HREF="sdlsemwaittimeout.html"></HEAD
><BODY
CLASS="REFENTRY"
BGCOLOR="#FFF8DC"
TEXT="#000000"
LINK="#0000ee"
VLINK="#551a8b"
ALINK="#ff0000"
><DIV
CLASS="NAVHEADER"
><TABLE
31
SUMMARY="Header navigation table"
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>SDL Library Documentation</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="sdlsemwait.html"
49
ACCESSKEY="P"
50
51
52
53
54
55
56
57
58
59
60
61
62
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
></TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="sdlsemwaittimeout.html"
63
ACCESSKEY="N"
64
65
66
67
68
69
70
71
72
73
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><H1
><A
NAME="SDLSEMTRYWAIT"
74
75
></A
>SDL_SemTryWait</H1
76
77
78
><DIV
CLASS="REFNAMEDIV"
><A
79
NAME="AEN8069"
80
81
82
83
84
85
86
></A
><H2
>Name</H2
>SDL_SemTryWait -- Attempt to lock a semaphore but don't suspend the thread.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
87
NAME="AEN8072"
88
89
90
91
92
93
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><A
94
NAME="AEN8073"
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
></A
><P
></P
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include "SDL.h"
#include "SDL_thread.h"</PRE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <B
CLASS="FSFUNC"
>SDL_SemTryWait</B
></CODE
>(SDL_sem *sem);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
119
NAME="AEN8079"
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>SDL_SemTryWait</TT
> is a non-blocking varient of
<A
HREF="sdlsemwait.html"
><TT
CLASS="FUNCTION"
>SDL_SemWait</TT
></A
>. If the value of the semaphore
pointed to by <TT
CLASS="PARAMETER"
><I
>sem</I
></TT
> is positive it will atomically
decrement the semaphore value and return 0, otherwise it will return
<SPAN
CLASS="RETURNVALUE"
144
>SDL_MUTEX_TIMEDOUT</SPAN
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
> instead of suspending the thread.</P
><P
>After <TT
CLASS="FUNCTION"
>SDL_SemTryWait</TT
> is successful, the semaphore
can be released and its count atomically incremented by a successful call to
<A
HREF="sdlsempost.html"
>SDL_SemPost</A
>.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
160
NAME="AEN8090"
161
162
163
164
165
166
167
168
169
170
></A
><H2
>Return Value</H2
><P
>Returns <SPAN
CLASS="RETURNVALUE"
>0</SPAN
> if the semaphore was successfully locked or
either <SPAN
CLASS="RETURNVALUE"
171
>SDL_MUTEX_TIMEDOUT</SPAN
172
173
174
175
176
177
178
179
180
181
182
> or <SPAN
CLASS="RETURNVALUE"
>-1</SPAN
>
if the thread would have suspended or there was an error, respectivly.</P
><P
>If the semaphore was not successfully locked, the semaphore will be unchanged.</P
></DIV
><DIV
CLASS="REFSECT1"
><A
183
NAME="AEN8097"
184
185
186
187
188
189
190
191
></A
><H2
>Examples</H2
><P
><PRE
CLASS="PROGRAMLISTING"
>res = SDL_SemTryWait(my_sem);
192
if (res == SDL_MUTEX_TIMEDOUT) {
193
194
195
196
197
198
199
200
201
202
203
204
205
206
return TRY_AGAIN;
}
if (res == -1) {
return WAIT_ERROR;
}
...
SDL_SemPost(my_sem);</PRE
></P
></DIV
><DIV
CLASS="REFSECT1"
><A
207
NAME="AEN8101"
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
></A
><H2
>See Also</H2
><P
><A
HREF="sdlcreatesemaphore.html"
><TT
CLASS="FUNCTION"
>SDL_CreateSemaphore</TT
></A
>,
<A
HREF="sdldestroysemaphore.html"
><TT
CLASS="FUNCTION"
>SDL_DestroySemaphore</TT
></A
>,
<A
HREF="sdlsemwait.html"
><TT
CLASS="FUNCTION"
>SDL_SemWait</TT
></A
>,
<A
HREF="sdlsemwaittimeout.html"
><TT
CLASS="FUNCTION"
>SDL_SemWaitTimeout</TT
></A
>,
<A
HREF="sdlsempost.html"
><TT
CLASS="FUNCTION"
>SDL_SemPost</TT
></A
>,
<A
HREF="sdlsemvalue.html"
><TT
CLASS="FUNCTION"
>SDL_SemValue</TT
></A
></P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
260
SUMMARY="Footer navigation table"
261
262
263
264
265
266
267
268
269
270
271
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="sdlsemwait.html"
272
ACCESSKEY="P"
273
274
275
276
277
278
279
280
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
281
ACCESSKEY="H"
282
283
284
285
286
287
288
289
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="sdlsemwaittimeout.html"
290
ACCESSKEY="N"
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SDL_SemWait</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="thread.html"
306
ACCESSKEY="U"
307
308
309
310
311
312
313
314
315
316
317
318
319
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SDL_SemWaitTimeout</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>