.\"  Automatically generated man page, do not edit
.TH QB_RB_CHUNK_READ 3 2023-07-21 "LIBQB" "libqb Programmer's Manual"
.SH NAME
qb_rb_chunk_read \- Read the oldest chunk into data_out. 

.SH SYNOPSIS
.nf
.B #include <qb/qbrb.h>
.sp
\fBssize_t qb_rb_chunk_read\fP(
    \fBqb_ringbuffer_t   *\fP\fIrb\fP,\fR          /* ringbuffer instance */
    \fBvoid              *\fP\fIdata_out\fP,\fR    /* (in/out) the chunk will be memcpy'ed into this. */
    \fBsize_t             \fP\fIlen\fP,\fR         /* (in) the size of data_out. */
    \fBint32_t            \fP\fIms_timeout\fP\fR   /* the amount od time to wait for new data. */
);
.fi
.SH PARAMS
\fBrb         \fP\fIringbuffer instance \fP
.PP
\fBdata_out   \fP\fI(in/out) the chunk will be memcpy'ed into this. \fP
.PP
\fBlen        \fP\fI(in) the size of data_out. \fP
.PP
\fBms_timeout \fP\fIthe amount od time to wait for new data. \fP
.PP
.SH DESCRIPTION
.PP
This is the same as \fIqb_rb_chunk_peek()\fR memcpy() and \fIqb_rb_chunk_reclaim()\fR.
.RE
.SH RETURN VALUE
.PP
the size of the chunk, or error. 
.PP
.SH SEE ALSO
.PP
.nh
.ad l
\fIqb_rb_close\fR(3), \fIqb_rb_refcount_get\fR(3), \fIqb_rb_chmod\fR(3), \fIqb_rb_chown\fR(3), \fIqb_rb_open\fR(3), \fIqb_rb_write_to_file\fR(3), \fIqb_rb_create_from_file\fR(3), \fIqb_rb_chunks_used\fR(3), \fIqb_rb_chunk_reclaim\fR(3), \fIqb_rb_space_used\fR(3), \fIqb_rb_chunk_write\fR(3), \fIqb_rb_shared_user_data_get\fR(3), \fIqb_rb_chunk_commit\fR(3), \fIqb_rb_chunk_peek\fR(3), \fIqb_rb_space_free\fR(3), \fIqb_rb_name_get\fR(3), \fIqb_rb_chunk_alloc\fR(3), 
.ad
.hy
.SH "COPYRIGHT"
.PP
Copyright (C) 2010-2020 Red Hat, Inc.