io_uring_wait_cqes_min_timeout(3) — Linux manual page

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

io_uring_wa...min_timeout(3) liburing Manual io_uring_wa...min_timeout(3)

NAME         top

       io_uring_wait_cqes_min_timeout - wait for completions with both
       batch and normal timeout

SYNOPSIS         top

       #include <liburing.h>

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

DESCRIPTION         top

       The io_uring_wait_cqes_min_timeout(3) waits for completions 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. If non-zero, min_wait_usec
       denotes a timeout for the wait_nr batch.

       The sigmask specifies the set of signals to block. If set, it is
       equivalent to atomically executing the following calls:

           sigset_t origmask;

           pthread_sigmask(SIG_SETMASK, &sigmask, &origmask);
           ret = io_uring_wait_cqes_min_timeout(ring, cqe, wait_nr, ts, min_wait, NULL);
           pthread_sigmask(SIG_SETMASK, &origmask, NULL);

       This works like io_uring_submit_and_wait_min_timeout(3) except
       that it doesn't submit requests. See that man page for a
       description for how the min timeout waiting works.

       Available since 6.12.

RETURN VALUE         top

       On success io_uring_wait_cqes_min_timeout(3) returns the 0.On
       failure it returns -errno.  If the kernel doesn't support this
       functionality, -EINVAL will be returned. See note on the feature
       flag.  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_wait_cqe(3), io_uring_wait_cqes(3),
       io_uring_wait_cqe_timeout(3), io_uring_wait_cqes(3),
       io_uring_submit_and_wait_min_timeout(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 2025-02-02.  (At that time,
       the date of the most recent commit that was found in the
       repository was 2025-01-22.)  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.8                   Feb 13, 2024  io_uring_wa...min_timeout(3)

Pages that refer to this page: io_uring_wait_cqes_min_timeout(3)