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.