debian man page for vrb_space_ptr

vrb_space_ptr(3)					      VRB Programmer's Manual						  vrb_space_ptr(3)

NAME
       vrb_space_ptr - return pointer to empty space

LIBRARY
       -lvrb

SYNOPSIS
       #include <vrb.h>

       size_t vrb_space_ptr(vrb_p vrb);

DESCRIPTION
       vrb_space_ptr  returns the pointer to the beginning of the contiguous block of empty space within the virtual ring buffer where data may be
       placed.	The pointer has meaning only if there is space in the buffer.  If there is no  space  in  the  buffer,	an  arbitrary  pointer	is
       returned that must not be used.	Use vrb_space_len(3) or vrb_is_full(3) to determine if vrb_space_ptr(3) has a meaningful pointer.

       The caller may access all of this space, and should call vrb_give(3) to indicate how much data has been placed into the buffer.

ARGUMENTS
       vrb_p vrb
       specifies the virtual ring buffer to obtain the empty space pointer from.  If a NULL or invalid pointer is given, results are unpredictable
       and are likely to be disasterous.

RETURN VALUE
       size_t
       The pointer to the empty space in the virtual ring buffer is returned.

SEE ALSO
       vrb(3),	vrb_capacity(3),  vrb_data_len(3),  vrb_data_ptr(3),  vrb_destroy(3),  vrb_get(3),   vrb_get_min(3),   vrb_give(3),   vrb_init(3),
       vrb_init_opt(3),   vrb_is_empty(3),  vrb_is_full(3),  vrb_is_not_empty(3),  vrb_is_not_full(3),	vrb_move(3),  vrb_new(3),  vrb_new_opt(3),
       vrb_put(3), vrb_put_all(3),  vrb_read(3),  vrb_read_min(3),  vrb_resize(3),  vrb_space_len(3),  vrb_take(3),  vrb_uninit(3),  vrb_write(3),
       vrb_write_min(3)

vrb								    2002-09-30							  vrb_space_ptr(3)