aboutsummaryrefslogtreecommitdiff
path: root/man/io_uring_get_sqe.3
diff options
context:
space:
mode:
authorGil Cukierman <cukie@google.com>2022-10-31 15:25:16 +0000
committerAutomerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>2022-10-31 15:25:16 +0000
commit1d27ff1934c5c4292dc00fba7f7f8ae411ed42f5 (patch)
treeebe9c872e416346e4b333e5062da32401c8e0a73 /man/io_uring_get_sqe.3
parentd53db6851ea17b2d219d084e1afc683b8b62b105 (diff)
parent7ba7e81400b122a5e3b9dd1ec938fbeda8215899 (diff)
downloadliburing-master.tar.gz
Original change: https://android-review.googlesource.com/c/platform/external/liburing/+/2276974 Change-Id: I2a7ecac6e769b82bba38ebfbce3301259a663146 Signed-off-by: Automerger Merge Worker <android-build-automerger-merge-worker@system.gserviceaccount.com>
Diffstat (limited to 'man/io_uring_get_sqe.3')
-rw-r--r--man/io_uring_get_sqe.322
1 files changed, 13 insertions, 9 deletions
diff --git a/man/io_uring_get_sqe.3 b/man/io_uring_get_sqe.3
index 24834f3..58c8b96 100644
--- a/man/io_uring_get_sqe.3
+++ b/man/io_uring_get_sqe.3
@@ -5,25 +5,28 @@
.\"
.TH io_uring_get_sqe 3 "July 10, 2020" "liburing-0.7" "liburing Manual"
.SH NAME
-io_uring_get_sqe - get the next vacant event from the submission queue
+io_uring_get_sqe \- get the next available submission queue entry from the
+submission queue
.SH SYNOPSIS
.nf
-.BR "#include <liburing.h>"
+.B #include <liburing.h>
.PP
-.BI "struct io_uring_sqe *io_uring_get_sqe(struct io_uring " *ring );
+.BI "struct io_uring_sqe *io_uring_get_sqe(struct io_uring *" ring ");"
.fi
-.PP
.SH DESCRIPTION
.PP
-The io_uring_get_sqe() function gets the next vacant event from the submission
+The
+.BR io_uring_get_sqe (3)
+function gets the next available submission queue entry from the submission
queue belonging to the
.I ring
param.
-On success io_uring_get_sqe() returns a pointer to the submission queue event.
-On failure NULL is returned.
+On success
+.BR io_uring_get_sqe (3)
+returns a pointer to the submission queue entry. On failure NULL is returned.
-If a submission queue event is returned, it should be filled out via one of the
+If a submission queue entry is returned, it should be filled out via one of the
prep functions such as
.BR io_uring_prep_read (3)
and submitted via
@@ -32,6 +35,7 @@ and submitted via
.SH RETURN VALUE
.BR io_uring_get_sqe (3)
returns a pointer to the next submission queue event on success and NULL on
-failure.
+failure. If NULL is returned, the SQ ring is currently full and entries must
+be submitted for processing before new ones can get allocated.
.SH SEE ALSO
.BR io_uring_submit (3)