|
HTML rendering created 2025-09-06 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. |
|
|
NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | COLOPHON |
|
|
|
io_uring_su...ait_timeout(3) liburing Manual io_uring_su...ait_timeout(3)
io_uring_submit_and_wait_timeout - submit requests to the
submission queue and wait for the completion with timeout
#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);
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. If set, it is
equivalent to atomically executing the following calls:
sigset_t origmask;
pthread_sigmask(SIG_SETMASK, &sigmask, &origmask);
ret = io_uring_submit_and_wait_timeout(ring, cqe, wait_nr, ts, NULL);
pthread_sigmask(SIG_SETMASK, &origmask, NULL);
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).
Ideally used with a ring setup with
IORING_SETUP_SINGLE_ISSUER|IORING_SETUP_DEFER_TASKRUN as that will
greatly reduce the number of context switches that an application
will see waiting on multiple requests.
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.
io_uring_queue_init_params(3), io_uring_get_sqe(3),
io_uring_submit(3), io_uring_submit_and_wait(3),
io_uring_wait_cqe(3)
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 2025-08-11. (At that time,
the date of the most recent commit that was found in the
repository was 2025-08-02.) 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, 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_min_timeout(3), io_uring_submit_and_wait_reg(3), io_uring_submit_and_wait_timeout(3)
|
HTML rendering created 2025-09-06 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. |
|