vrb_space

vrb_space_len

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

NAME

vrb_space_len - return the length of space

LIBRARY

-lvrb

SYNOPSIS

#include <vrb.h>

size_t vrb_space_len(vrb_p vrb);

DESCRIPTION

vrb_space_len returns the total length of space available in the given virtual ring buffer. This is the maximum space the caller may store into the buffer from the pointer returned by vrb_space_ptr(3).

ARGUMENTS

vrb_p vrb
specifies the virtual ring buffer to obtain the length of available space in. If a NULL or invalid pointer is given, results are unpredictable and are likely to be disasterous.

RETURN VALUE

size_t
The length of available space in the virtual ring buffer is returned.

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_ptr(3), vrb_take(3), vrb_uninit(3), vrb_write(3), vrb_write_min(3)

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