io_uring_wait_cqe(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | COLOPHON

io_uring_wait_cqe(3)         liburing Manual        io_uring_wait_cqe(3)

NAME         top

       io_uring_wait_cqe - wait for one io_uring completion event

SYNOPSIS         top

       #include <liburing.h>

       int io_uring_wait_cqe(struct io_uring *ring,
                             struct io_uring_cqe **cqe_ptr);

DESCRIPTION         top

       The io_uring_wait_cqe(3) function waits for an IO completion from
       the queue belonging to the ring param, waiting for it if
       necessary. If an event is 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         top

       On success io_uring_wait_cqe(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_cqe_timeout(3),
       io_uring_wait_cqes(3)

COLOPHON         top

       This page is part of the liburing (A library for io_uring)
       project.  Information about the project can be found at 
       ⟨https://github.com/axboe/liburing⟩.  If you have a bug report for
       this manual page, send it to [email protected].  This page
       was obtained from the project's upstream Git repository
       ⟨https://github.com/axboe/liburing⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2024-06-03.)  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
       [email protected]

liburing-2.1                November 15, 2021       io_uring_wait_cqe(3)

Pages that refer to this page: io_uring_cq_advance(3)io_uring_cqe_get_data(3)io_uring_cqe_get_data64(3)io_uring_cqe_seen(3)io_uring_cq_ready(3)io_uring_for_each_cqe(3)io_uring_peek_cqe(3)io_uring_sqring_wait(3)io_uring_submit_and_wait_timeout(3)io_uring_wait_cqe(3)io_uring_wait_cqe_nr(3)io_uring_wait_cqes(3)io_uring_wait_cqe_timeout(3)