io_uring_submit_and_wait_timeout(3) — Linux manual page

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

io_uring_su...ait_timeout(3) liburing Manualio_uring_su...ait_timeout(3)

NAME         top

       io_uring_submit_and_wait_timeout - submit requests to the
       submission queue and wait for the completion with timeout

SYNOPSIS         top

       #include <liburing.h>

       int io_uring_submit_and_wait_timeout(struct io_uring *ring,
                                            struct io_uring_cqe **cqe_ptr,
                                            unsigned wait_nr,
                                            struct __kernel_timespec *ts,
                                            sigset_t *sigmask);

DESCRIPTION         top

       The io_uring_submit_and_wait_timeout(3) function submits the next
       requests from the submission queue belonging to the ring and
       waits for wait_nr completion events, or until the timeout ts
       expires. The completion events are stored in the cqe_ptr array.
       The sigmask specifies the set of signals to block. The prevailing
       signal mask is restored before returning.

       After the caller retrieves a submission queue entry (SQE) with
       io_uring_get_sqe(3) and prepares the SQE, it can be submitted
       with io_uring_submit_and_wait_timeout(3).

RETURN VALUE         top

       On success io_uring_submit_and_wait_timeout(3) returns the number
       of submitted submission queue entries. On failure it returns
       -errno.  Note that in earlier versions of the liburing library,
       the return value was 0 on success.  The most common failure case
       is not receiving a completion within the specified timeout,
       -ETIME is returned in this case.

SEE ALSO         top

       io_uring_get_sqe(3), io_uring_submit(3),
       io_uring_submit_and_wait(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 
       ⟨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 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
       man-pages@man7.org

liburing-2.1                November 15, 2021io_uring_su...ait_timeout(3)

Pages that refer to this page: io_uring_submit(3)io_uring_submit_and_wait(3)io_uring_submit_and_wait_timeout(3)