vrb_uninit(3)

Usage

#include <vrb.h>

vrb_p vrb_uninit(vrb_p vrb);

Library

-lvrb

Overview

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.

Releases

Unchanged in 2 releases since Debian 6.0 (Squeeze).

6.0–7

Mentioned on this page

vrb_uninit(3) uninit a virtual ring buffer

Referred to by

vrb(3) virtual ring buffer vrb_get(3) get data from a VRB vrb_new(3) create a new virtual ring buffer vrb_put(3) put data into a VRB vrb_give(3) create a new virtual ring buffer vrb_init(3) initialize a virtual ring buffer vrb_move(3) read data into a VRB vrb_read(3) read data into a VRB vrb_take(3) take data from a VRB vrb_write(3) write data from a VRB vrb_resize(3) create a new virtual ring buffer vrb_destroy(3) destroy a virtual ring buffer vrb_get_min(3) get minimum data from a VRB vrb_is_full(3) indicate if VRB is full vrb_new_opt(3) create a new virtual ring buffer vrb_put_all(3) put all data into a VRB vrb_capacity(3) return the buffer capacity vrb_data_len(3) return the length of data vrb_data_ptr(3) return pointer to data vrb_init_opt(3) initialize a virtual ring buffer vrb_is_empty(3) indicate if VRB is empty vrb_read_min(3) read a minimum of data into a VRB vrb_space_len(3) return the length of space vrb_space_ptr(3) return pointer to empty space vrb_write_min(3) write data from a VRB vrb_is_not_full(3) indicate if VRB is not_full vrb_is_not_empty(3) indicate if VRB is not_empty