io_uring_wait_cqe_timeout(3) — Linux manual page


io_uring_wait_cqe_timeout(3) liburing Manualio_uring_wait_cqe_timeout(3)

NAME         top

       io_uring_wait_cqe_timeout - wait for one io_uring completion
       event with timeout

SYNOPSIS         top

       #include <liburing.h>

       int io_uring_wait_cqe_timeout(struct io_uring *ring,
                                     struct io_uring_cqe **cqe_ptr,
                                     struct __kernel_timespec *ts);

DESCRIPTION         top

       The io_uring_wait_cqe_timeout(3) function waits for one IO
       completion to be available from the queue belonging to the ring
       param, waiting for it if necessary or until the timeout ts
       expires. If an event is already available in the ring when
       invoked, no waiting will occur.

       The cqe_ptr param is filled in on success.

       If ts is specified and an older kernel without
       IORING_FEAT_EXT_ARG is used, the application does not need to
       call io_uring_submit(3) before calling io_uring_wait_cqes(3).
       For newer kernels with that feature flag set, there is no implied
       submit when waiting for a request.

RETURN VALUE         top

       On success io_uring_wait_cqe_timeout(3) returns 0 and the cqe_ptr
       param 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         top

       io_uring_submit(3), io_uring_wait_cqes(3), io_uring_wait_cqe(3)

COLOPHON         top

       This page is part of the liburing (A library for io_uring)
       project.  Information about the project can be found at 
       ⟨⟩.  If you have a bug report for
       this manual page, send it to  This page
       was obtained from the project's upstream Git repository
       ⟨⟩ on 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-19.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to

liburing-2.1                November 15, 2021io_uring_wait_cqe_timeout(3)

Pages that refer to this page: io_uring_cq_advance(3)io_uring_cqe_seen(3)io_uring_for_each_cqe(3)io_uring_wait_cqe(3)io_uring_wait_cqes(3)io_uring_wait_cqe_timeout(3)