Snap for 10453563 from 1d27ff1934c5c4292dc00fba7f7f8ae411ed42f5 to mainline-os-statsd-releaseaml_sta_341710000aml_sta_341615000aml_sta_341511040aml_sta_341410000aml_sta_341311010aml_sta_341114000aml_sta_341111000aml_sta_341010020aml_sta_340912000aml_sta_340911000aml_net_341111030android14-mainline-os-statsd-release

Change-Id: I92aad81dca3afa0dc7b00b53365472f7f29e4b40

1 files changed, 43 insertions, 0 deletions

diff --git a/man/io_uring_wait_cqe_nr.3 b/man/io_uring_wait_cqe_nr.3
new file mode 100644
index 0000000..5a4a5d5
--- /dev/null
+++ b/man/io_uring_wait_cqe_nr.3
@@ -0,0 +1,43 @@
+.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
+.\"
+.\" SPDX-License-Identifier: LGPL-2.0-or-later
+.\"
+.TH io_uring_wait_cqe_nr 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
+.SH NAME
+io_uring_wait_cqe_nr \- wait for one or more io_uring completion events
+.SH SYNOPSIS
+.nf
+.B #include <liburing.h>
+.PP
+.BI "int io_uring_wait_cqe_nr(struct io_uring *" ring ","
+.BI "                         struct io_uring_cqe **" cqe_ptr ","
+.BI "                         unsigned " wait_nr ");"
+.fi
+.SH DESCRIPTION
+.PP
+The
+.BR io_uring_wait_cqe_nr (3)
+function returns
+.I wait_nr
+IO completion events from the queue belonging to the
+.I ring
+param, waiting for it if necessary. If the requested number of events are
+already available in the ring when invoked, no waiting will occur. The
+.I cqe_ptr
+param is filled in on success.
+
+After the caller has submitted a request with
+.BR io_uring_submit (3),
+the application can retrieve the completion with
+.BR io_uring_wait_cqe (3).
+
+.SH RETURN VALUE
+On success
+.BR io_uring_wait_cqe_nr (3)
+returns 0 and the cqe_ptr parm is filled in. On failure it returns
+.BR -errno .
+The return value indicates the result of waiting for a CQE, and it has no
+relation to the CQE result itself.
+.SH SEE ALSO
+.BR io_uring_submit (3),
+.BR io_uring_wait_cqes (3)