vrb_take(3) take data from a VRB

LIBRARY

-lvrb

SYNOPSIS

#include <vrb.h>

vrb_p vrb_take(vrb_p vrb, size_t size);

DESCRIPTION

vrb_take specifies how much data has been obtained from the data portion of the virtual ring buffer by the caller.

The caller will have called vrb_data_len(3) and vrb_data_ptr(3) to get the length of data in the buffer and a pointer to it, and having extract some data from the buffer, starting from the pointer obtained and extrating no more that the length obtained.

ARGUMENTS

vrb_p vrb
specifies which virtual ring buffer.

size_t size
specifies the length of data that has been obtained from the virtual ring buffer by the caller.

RETURN VALUE

int
On success, 0 is returned. On error, -1 is returned.

ERRORS

If an error is returned, then errno will have one of the following values:
EINVAL
An invalid virtual ring buffer pointer was specified.
ENOSPC
The specified length is greater than the data in the virtual ring buffer.