Poster of Linux kernelThe best gift for a Linux geek
vrb_data_ptr

vrb_data_ptr

Section: VRB Programmer's Manual (3) Updated: 2002-09-30
Local index Up
 

NAME

vrb_data_ptr - return pointer to data  

LIBRARY

-lvrb  

SYNOPSIS

#include <vrb.h>

size_t vrb_data_ptr(vrb_p vrb);  

DESCRIPTION

vrb_data_ptr returns the pointer to the beginning of the contiguous block of data within the virtual ring buffer. The pointer has meaning only if there is data in the buffer. If there is no data in the buffer, an arbitrary pointer is returned and must not be used. Use vrb_data_len(3) or vrb_is_empty(3) to determine if vrb_data_ptr(3) has a meaningful pointer.

The caller may access all of this data, and should call vrb_take(3) to indicate how much data has been removed from the buffer.  

ARGUMENTS

vrb_p vrb
specifies the virtual ring buffer to obtain the data 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 data in the virtual ring buffer is returned.  

SEE ALSO

vrb(3), vrb_capacity(3), vrb_data_len(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_space_ptr(3), vrb_take(3), vrb_uninit(3), vrb_write(3), vrb_write_min(3)


 

Index

NAME
LIBRARY
SYNOPSIS
DESCRIPTION
ARGUMENTS
RETURN VALUE
SEE ALSO

This document was created by man2html, using the manual pages.
Time: 21:58:08 GMT, April 16, 2011