io_uring_cqe_get_data(3) — Linux manual page

io_uring_cqe_get_data(3)     liburing Manual    io_uring_cqe_get_data(3)

NAME         top

       io_uring_cqe_get_data - get user data for completion event

SYNOPSIS         top

       #include <liburing.h>

       void *io_uring_cqe_get_data(struct io_uring_cqe *cqe);

       __u64 io_uring_cqe_get_data64(struct io_uring_cqe *cqe);

DESCRIPTION         top

       The io_uring_cqe_get_data(3) function returns the user_data with
       the completion queue entry cqe as a data pointer.

       The io_uring_cqe_get_data64(3) function returns the user_data
       with the completion queue entry cqe as a 64-bit data value.

       After the caller has received a completion queue entry (CQE) with
       io_uring_wait_cqe(3), the application can call
       io_uring_cqe_get_data(3) or io_uring_cqe_get_data64(3) function
       to retrieve the user_data value. This requires that user_data has
       been set earlier with the function io_uring_sqe_set_data(3) or
       io_uring_sqe_set_data64(3).

RETURN VALUE         top

       If the user_data value has been set before submitting the
       request, it will be returned.  Otherwise, the return value is
       undefined.

SEE ALSO         top

       io_uring_get_sqe(3), io_uring_sqe_set_data(3),
       io_uring_sqe_submit(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                November 15, 2021   io_uring_cqe_get_data(3)

Pages that refer to this page: io_uring_cqe_get_data(3),  io_uring_cqe_get_data64(3),  io_uring_get_sqe(3),  io_uring_sqe_set_data(3),  io_uring_sqe_set_data64(3)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.