NAME
vrb_uninit - uninit a virtual ring buffer
LIBRARY
-lvrb
SYNOPSIS
#include <vrb.h>
vrb_p vrb_uninit(vrb_p vrb);
DESCRIPTION
vrb_uninit releases the resources of a virtual ring buffer controlled
by a static structure initialized by vrb_init(3) or vrb_init_opt(3).
When the calling program has no more need for the virtual ring buffer,
vrb_uninit(3) should be called to release all resources. The caller is
responsible for the original structure space.
ARGUMENTS
vrb_p vrb
specifies the virtual ring buffer to be uninitialized.
RETURN VALUE
int
On success, 0 is returned. On error, -1 is returned.
ERRORS
If an error is returned, then errno will have the following value:
EINVAL An invalid virtual ring buffer pointer was given.
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_space_ptr(3), vrb_take(3),
vrb_write(3), vrb_write_min(3)