xref: /aosp_15_r20/external/liburing/man/io_uring_wait_cqe_nr.3 (revision 25da2bea747f3a93b4c30fd9708b0618ef55a0e6)
Copyright (C) 2021 Stefan Roesch <[email protected]>

SPDX-License-Identifier: LGPL-2.0-or-later

io_uring_wait_cqe_nr 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
NAME
io_uring_wait_cqe_nr - wait for one or more io_uring completion events
SYNOPSIS
 #include <liburing.h> 

"int io_uring_wait_cqe_nr(struct io_uring *" ring "," " struct io_uring_cqe **" cqe_ptr "," " unsigned " wait_nr ");"

DESCRIPTION

The io_uring_wait_cqe_nr (3) function returns wait_nr IO completion events from the queue belonging to the 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 cqe_ptr param is filled in on success. After the caller has submitted a request with io_uring_submit (3), the application can retrieve the completion with io_uring_wait_cqe (3).

RETURN VALUE
On success io_uring_wait_cqe_nr (3) returns 0 and the cqe_ptr parm is filled in. On failure it returns -errno . The return value indicates the result of waiting for a CQE, and it has no relation to the CQE result itself.
SEE ALSO
io_uring_submit (3), io_uring_wait_cqes (3)