io_uring_submit_and_wait_timeout - Man Page

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

Synopsis

#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

The io_uring_submit_and_wait_timeout(3) function submits the next events to 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

On success io_uring_submit_and_wait_timeout(3) returns the number of submitted submission queue entries. On failure it returns -errno. The most common failure case is not receiving a completion within the specified timeout, -ETIME is returned in this case.

See Also

io_uring_get_sqe(3), io_uring_submit(3), io_uring_submit_and_wait(3), io_uring_wait_cqe(3)

Info

November 15, 2021 liburing-2.1 liburing Manual