vrb_capacity

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

NAME

vrb_capacity - return the buffer capacity

LIBRARY

-lvrb

SYNOPSIS

#include <vrb.h>

size_t vrb_capacity(vrb_p vrb);

DESCRIPTION

vrb_capacity returns the total buffer capacity (after any rounding up during initialization) of the given virtual ring buffer.

ARGUMENTS

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

RETURN VALUE

size_t
The total capacity of the virtual ring buffer is returned.

vrb(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_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:08 GMT, April 16, 2011