.\"  Automatically generated man page, do not edit
.TH QB_RB_OPEN 3 2023-07-21 "LIBQB" "libqb Programmer's Manual"
.SH NAME
qb_rb_open \- Create the ring buffer with the given type. 

.SH SYNOPSIS
.nf
.B #include <qb/qbrb.h>
.sp
\fBqb_ringbuffer_t * qb_rb_open\fP(
    \fBconst char   *\fP\fIname\fP,\fR                   /* the unique name of this ringbuffer. */
    \fBsize_t        \fP\fIsize\fP,\fR                   /* the requested size. */
    \fBuint32_t      \fP\fIflags\fP,\fR                  /* or'ed flags */
    \fBsize_t        \fP\fIshared_user_data_size\fP\fR   /* size for a shared data area. */
);
.fi
.SH PARAMS
\fBname                  \fP\fIthe unique name of this ringbuffer. \fP
.PP
\fBsize                  \fP\fIthe requested size. \fP
.PP
\fBflags                 \fP\fIor'ed flags \fP
.PP
\fBshared_user_data_size \fP\fIsize for a shared data area. \fP
.PP
.SH DESCRIPTION
.PP
This creates allocates a ring buffer in shared memory.
.SH RETURN VALUE
.PP
a new ring buffer or NULL if there was a problem. 
.PP
.SH NOTE
.PP
the actual size will be rounded up to the next page size. 
.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_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), \fIqb_rb_chunk_read\fR(3)
.ad
.hy
.SH "COPYRIGHT"
.PP
Copyright (C) 2010-2020 Red Hat, Inc.