You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
91 lines
3.0 KiB
91 lines
3.0 KiB
11 years ago
|
/*****************************************************************************
|
||
|
|
* vlc_interrupt.h:
|
||
|
|
*****************************************************************************
|
||
|
|
* Copyright (C) 2015 Remlab T:mi
|
||
|
|
*
|
||
|
|
* This program is free software; you can redistribute it and/or modify it
|
||
|
|
* under the terms of the GNU Lesser General Public License as published by
|
||
|
|
* the Free Software Foundation; either version 2.1 of the License, or
|
||
|
|
* (at your option) any later version.
|
||
|
|
*
|
||
|
|
* This program 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 Lesser General Public License for more details.
|
||
|
|
*
|
||
|
|
* You should have received a copy of the GNU Lesser General Public License
|
||
|
|
* along with this program; if not, write to the Free Software Foundation,
|
||
|
|
* Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
|
||
|
|
*****************************************************************************/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @file
|
||
|
|
* This file declares interruptible sleep functions.
|
||
|
|
*/
|
||
|
|
|
||
|
|
#ifndef VLC_INTERRUPT_H
|
||
|
|
# define VLC_INTERRUPT_H 1
|
||
|
|
# include <vlc_threads.h>
|
||
|
|
/**
|
||
|
|
* @defgroup interrupt Interruptible sleep
|
||
|
|
* @{
|
||
|
|
* @defgroup interrupt_sleep Interruptible sleep functions
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Waits on a semaphore like vlc_sem_wait(). If the calling thread has an
|
||
|
|
* interruption context (as set by vlc_interrupt_set()), and another thread
|
||
|
|
* invokes vlc_interrupt_raise() on that context, the semaphore is incremented.
|
||
|
|
*
|
||
|
|
* @warning The calling thread should be the only thread ever to wait on the
|
||
|
|
* specified semaphore. Otherwise, interruptions may not be delivered
|
||
|
|
* accurately (the wrong thread may be woken up).
|
||
|
|
*
|
||
|
|
* @note This function is (always) a cancellation point.
|
||
|
|
*
|
||
|
|
* @return EINTR if the semaphore was incremented due to an interruption,
|
||
|
|
* otherwise zero.
|
||
|
|
*/
|
||
|
|
VLC_API int vlc_sem_wait_i11e(vlc_sem_t *);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @}
|
||
|
|
* @defgroup interrupt_context Interrupt context signaling and manipulation
|
||
|
|
* @{
|
||
|
|
*/
|
||
|
|
typedef struct vlc_interrupt vlc_interrupt_t;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Creates an interruption context.
|
||
|
|
*/
|
||
|
|
VLC_API vlc_interrupt_t *vlc_interrupt_create(void) VLC_USED;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Destroys an interrupt context.
|
||
|
|
*/
|
||
|
|
VLC_API void vlc_interrupt_destroy(vlc_interrupt_t *);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets the interruption context for the calling thread.
|
||
|
|
* @param newctx the interruption context to attach or NULL for none
|
||
|
|
* @return the previous interruption context or NULL if none
|
||
|
|
*
|
||
|
|
* @note This function is not a cancellation point.
|
||
|
|
* @warning A context can be attached to no more than one thread at a time.
|
||
|
|
*/
|
||
|
|
VLC_API vlc_interrupt_t *vlc_interrupt_set(vlc_interrupt_t *);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Raises an interruption through a specified context. This is used to
|
||
|
|
* asynchronously wake a thread up while it is waiting on some other events
|
||
|
|
* (typically I/O events).
|
||
|
|
*
|
||
|
|
* @note This function is thread-safe.
|
||
|
|
* @note This function is not a cancellation point.
|
||
|
|
*/
|
||
|
|
VLC_API void vlc_interrupt_raise(vlc_interrupt_t *);
|
||
|
|
|
||
|
|
/** @} @} */
|
||
|
|
#endif
|