io_uring_cq_advance(3) — Linux manual page

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

io_uring_cq_advance(3)       liburing Manual      io_uring_cq_advance(3)

NAME         top

       io_uring_cq_advance - mark one or more io_uring completion events
       as consumed

SYNOPSIS         top

       #include <liburing.h>

       void io_uring_cq_advance(struct io_uring *ring,
                                 unsigned nr);

DESCRIPTION         top

       The io_uring_cq_advance(3) function marks nr IO completions
       belonging to the ring param as consumed.

       After the caller has submitted a request with io_uring_submit(3),
       the application can retrieve the completion with
       io_uring_wait_cqe(3), io_uring_peek_cqe(3), or any of the other
       CQE retrieval helpers, and mark it as consumed with
       io_uring_cqe_seen(3).

       The function io_uring_cqe_seen(3) calls the function
       io_uring_cq_advance(3).

       Completions must be marked as seen, so their slot can get reused.
       Failure to do so will result in the same completion being
       returned on the next invocation.

RETURN VALUE         top

       None

SEE ALSO         top

       io_uring_submit(3), io_uring_wait_cqe(3), io_uring_peek_cqe(3),
       io_uring_wait_cqes(3), io_uring_wait_cqe_timeout(3),
       io_uring_cqe_seen(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 io-uring@vger.kernel.org.  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
       man-pages@man7.org

liburing-2.1                January 25, 2022      io_uring_cq_advance(3)

Pages that refer to this page: io_uring_buf_ring_cq_advance(3)__io_uring_buf_ring_cq_advance(3)io_uring_cq_advance(3)io_uring_for_each_cqe(3)