vrb_take(3)

vrb_take3

Take data from a vrb

Usage

#include <vrb.h>

vrb_p vrb_take(vrb_p vrb, size_t size);

Library

-lvrb

Overview

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.

Releases

Unchanged in 2 releases since Debian 6.0 (Squeeze).

  1. 6.0–7

From libvrb0-dev 0.5.1-5.1 in Debian 7 (Wheezy). Parsed by carta from the page's man source.