aboutsummaryrefslogtreecommitdiff
path: root/man/io_uring_buf_ring_advance.3
diff options
context:
space:
mode:
authorAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2023-07-07 05:10:09 +0000
committerAndroid Build Coastguard Worker <android-build-coastguard-worker@google.com>2023-07-07 05:10:09 +0000
commitb8f7e9523bba270978886a4377312b927e024620 (patch)
treeebe9c872e416346e4b333e5062da32401c8e0a73 /man/io_uring_buf_ring_advance.3
parentd53db6851ea17b2d219d084e1afc683b8b62b105 (diff)
parent1d27ff1934c5c4292dc00fba7f7f8ae411ed42f5 (diff)
downloadliburing-b8f7e9523bba270978886a4377312b927e024620.tar.gz
Change-Id: Ifb21a10d7ab7ff789b497736136922bb8d723b0e
Diffstat (limited to 'man/io_uring_buf_ring_advance.3')
-rw-r--r--man/io_uring_buf_ring_advance.331
1 files changed, 31 insertions, 0 deletions
diff --git a/man/io_uring_buf_ring_advance.3 b/man/io_uring_buf_ring_advance.3
new file mode 100644
index 0000000..29a3578
--- /dev/null
+++ b/man/io_uring_buf_ring_advance.3
@@ -0,0 +1,31 @@
+.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_buf_ring_advance 3 "May 18, 2022" "liburing-2.2" "liburing Manual"
+.SH NAME
+io_uring_buf_ring_advance \- advance index of provided buffer in buffer ring
+.SH SYNOPSIS
+.nf
+.B #include <liburing.h>
+.PP
+.BI "int io_uring_buf_ring_advance(struct io_uring_buf_ring *" br ",
+.BI " int " count ");"
+.fi
+.SH DESCRIPTION
+.PP
+The
+.BR io_uring_buf_ring_advance (3)
+commits
+.I count
+previously added buffers to the shared buffer ring
+.IR br ,
+making them visible to the kernel and hence consumable. This passes ownership
+of the buffer to the ring.
+
+.SH RETURN VALUE
+None
+.SH SEE ALSO
+.BR io_uring_register_buf_ring (3),
+.BR io_uring_buf_ring_add (3),
+.BR io_uring_buf_ring_cq_advance (3)