Function sdl2_sys::SDL_SemWaitTimeout

source ยท 
pub unsafe extern "C" fn SDL_SemWaitTimeout(
    sem: *mut SDL_sem,
    ms: Uint32,
) -> c_int
Expand description

Wait until a semaphore has a positive value and then decrements it.

This function suspends the calling thread until either the semaphore pointed to by sem has a positive value, the call is interrupted by a signal or error, or the specified time has elapsed. If the call is successful it will atomically decrement the semaphore value.

\param sem the semaphore to wait on \param ms the length of the timeout, in milliseconds \returns 0 if the wait succeeds, SDL_MUTEX_TIMEDOUT if the wait does not succeed in the allotted time, or a negative error code on failure; call SDL_GetError() for more information.

\since This function is available since SDL 2.0.0.

\sa SDL_CreateSemaphore \sa SDL_DestroySemaphore \sa SDL_SemPost \sa SDL_SemTryWait \sa SDL_SemValue \sa SDL_SemWait