docs/man3/SDL_SemWaitTimeout.3
author Sam Lantinga <slouken@libsdl.org>
Wed, 08 Mar 2006 18:30:12 +0000
changeset 1486 9d77fc9d0ace
parent 181 e5bc29de3f0a
child 2283 546f7c1eb755
permissions -rw-r--r--
Re-added C runtime support for Visual C++ 5,6
slouken@181
     1
.TH "SDL_SemWaitTimeout" "3" "Tue 11 Sep 2001, 23:00" "SDL" "SDL API Reference" 
slouken@0
     2
.SH "NAME"
slouken@0
     3
SDL_SemWaitTimeout\- Lock a semaphore, but only wait up to a specified maximum time\&.
slouken@0
     4
.SH "SYNOPSIS"
slouken@0
     5
.PP
slouken@0
     6
\fB#include "SDL\&.h"
slouken@0
     7
#include "SDL_thread\&.h"
slouken@0
     8
.sp
slouken@0
     9
\fBint \fBSDL_SemWaitTimeout\fP\fR(\fBSDL_sem *sem, Uint32 timeout\fR);
slouken@0
    10
.SH "DESCRIPTION"
slouken@0
    11
.PP
slouken@0
    12
\fBSDL_SemWaitTimeout()\fP is a varient of \fISDL_SemWait\fR with a maximum timeout value\&. If the value of the semaphore pointed to by \fBsem\fR is positive (greater than zero) it will atomically decrement the semaphore value and return 0, otherwise it will wait up to \fBtimeout\fR milliseconds trying to lock the semaphore\&. This function is to be avoided if possible since on some platforms it is implemented by polling the semaphore every millisecond in a busy loop\&.
slouken@0
    13
.PP
slouken@0
    14
After \fBSDL_SemWaitTimeout()\fP is successful, the semaphore can be released and its count atomically incremented by a successful call to \fISDL_SemPost\fR\&.
slouken@0
    15
.SH "RETURN VALUE"
slouken@0
    16
.PP
slouken@0
    17
Returns \fB0\fR if the semaphore was successfully locked or either \fBSDL_MUTEX_TIMEOUT\fR or \fB-1\fR if the timeout period was exceeded or there was an error, respectivly\&.
slouken@0
    18
.PP
slouken@0
    19
If the semaphore was not successfully locked, the semaphore will be unchanged\&.
slouken@0
    20
.SH "EXAMPLES"
slouken@0
    21
.PP
slouken@0
    22
.PP
slouken@0
    23
.nf
slouken@0
    24
\f(CWres = SDL_SemWaitTimeout(my_sem, WAIT_TIMEOUT_MILLISEC);
slouken@0
    25
slouken@0
    26
if (res == SDL_MUTEX_TIMEOUT) {
slouken@0
    27
        return TRY_AGAIN;
slouken@0
    28
}
slouken@0
    29
if (res == -1) {
slouken@0
    30
        return WAIT_ERROR;
slouken@0
    31
}
slouken@0
    32
slouken@0
    33
\&.\&.\&.
slouken@0
    34
slouken@0
    35
SDL_SemPost(my_sem);\fR
slouken@0
    36
.fi
slouken@0
    37
.PP
slouken@0
    38
.SH "SEE ALSO"
slouken@0
    39
.PP
slouken@0
    40
\fI\fBSDL_CreateSemaphore\fP\fR, \fI\fBSDL_DestroySemaphore\fP\fR, \fI\fBSDL_SemWait\fP\fR, \fI\fBSDL_SemTryWait\fP\fR, \fI\fBSDL_SemPost\fP\fR, \fI\fBSDL_SemValue\fP\fR
slouken@181
    41
...\" created by instant / docbook-to-man, Tue 11 Sep 2001, 23:00