aboutsummaryrefslogtreecommitdiff
path: root/man/io_uring_cq_ready.3
diff options
context:
space:
mode:
Diffstat (limited to 'man/io_uring_cq_ready.3')
-rw-r--r--man/io_uring_cq_ready.326
1 files changed, 26 insertions, 0 deletions
diff --git a/man/io_uring_cq_ready.3 b/man/io_uring_cq_ready.3
new file mode 100644
index 0000000..e411a64
--- /dev/null
+++ b/man/io_uring_cq_ready.3
@@ -0,0 +1,26 @@
+.\" Copyright (C) 2022 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_cq_ready "January 25, 2022" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_cq_ready \- returns number of unconsumed ready entries in the CQ ring
+.SH SYNOPSIS
+.nf
+.B #include <liburing.h>
+.PP
+.BI "unsigned io_uring_cq_ready(const struct io_uring *" ring ");"
+.fi
+.SH DESCRIPTION
+.PP
+The
+.BR io_uring_cq_ready (3)
+function retuns the number of unconsumed entries that are ready belonging to the
+.I ring
+param.
+
+.SH RETURN VALUE
+Returns the number of unconsumed ready entries in the CQ ring.
+.SH SEE ALSO
+.BR io_uring_submit (3),
+.BR io_uring_wait_cqe (3)