From f2da8f85f1dc263a8f040ded811e132973dd2e94 Mon Sep 17 00:00:00 2001 From: =?utf8?q?R=C3=A9mi=20Denis-Courmont?= Date: Mon, 16 Nov 2009 20:10:53 +0200 Subject: [PATCH] Document block_FifoGet and block_FifoShow --- src/misc/block.c | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/src/misc/block.c b/src/misc/block.c index 580237957d..433c742d85 100644 --- a/src/misc/block.c +++ b/src/misc/block.c @@ -601,6 +601,12 @@ void block_FifoWake( block_fifo_t *p_fifo ) vlc_mutex_unlock( &p_fifo->lock ); } +/** + * Dequeue the first block from the FIFO. If necessary, wait until there is + * one block in the queue. This function is (always) cancellation point. + * + * @return a valid block, or NULL if block_FifoWake() was called. + */ block_t *block_FifoGet( block_fifo_t *p_fifo ) { block_t *b; @@ -643,6 +649,17 @@ block_t *block_FifoGet( block_fifo_t *p_fifo ) return b; } +/** + * Peeks the first block in the FIFO. + * If necessary, wait until there is one block. + * This function is (always) a cancellation point. + * + * @warning This function leaves the block in the FIFO. + * You need to protect against concurrent threads who could dequeue the block. + * Preferrably, there should be only one thread reading from the FIFO. + * + * @return a valid block. + */ block_t *block_FifoShow( block_fifo_t *p_fifo ) { block_t *b; -- 2.39.5