1io_uring_free_buf_ring(3)       liburing Manual      io_uring_free_buf_ring(3)
2
3
4

NAME

6       io_uring_free_buf_ring  -  register and free a buffer ring for provided
7       buffers
8

SYNOPSIS

10       #include <liburing.h>
11
12       int io_uring_free_buf_ring(struct io_uring *ring,
13                                  struct io_uring_buf_ring *br,
14                                  unsigned int nentries,
15                                  int bgid);
16
17

DESCRIPTION

19       The io_uring_free_buf_ring(3) function unregisters a previously  regis‐
20       tered  shared  buffer ring. The ring must have heen previously returned
21       from io_uring_setup_buf_ring(3).
22
23       The ring argument must pointer to the ring for which the provided  buf‐
24       fer ring is being registered, br must point to a buffer ring previously
25       returned by io_uring_setup_buf_ring(3), nentries is the number  of  en‐
26       tries  requested  in  the  buffer ring, and bgid is the buffer group ID
27       that br was setup with.
28
29       Under the covers, this function uses io_uring_unregister_buf_ring(3) to
30       unregister  the  ring,  and handles the freeing of the ring rather than
31       letting the application open code it.
32
33       Available since 5.19.
34
35

RETURN VALUE

37       On success io_uring_register_free_ring(3)  returns  a  pointer  to  the
38       buffe ring. On failure it returns -errno.
39

SEE ALSO

41       io_uring_setup_buf_ring(3)
42
43
44
45liburing-2.4                     Mar 07, 2023        io_uring_free_buf_ring(3)