summaryrefslogtreecommitdiff
path: root/man/io_uring_submit_and_wait_timeout.3
blob: 2fd22baecb0a8692383e1cc071fa8fe3c9e70767 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_submit_and_wait_timeout 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_submit_and_wait_timeout - submit requests to the submission queue and
wait for the completion with timeout
.fi
.SH SYNOPSIS
.nf
.BR "#include <liburing.h>"
.PP
.BI "int io_uring_submit_and_wait_timeout(struct io_uring *" ring ","
.BI "                                     struct io_uring_cqe **" cqe_ptr ","
.BI "                                     unsigned " wait_nr ","
.BI "                                     struct __kernel_timespec *" ts ","
.BI "                                     sigset_t *" sigmask ");"
.PP
.SH DESCRIPTION
.PP
The io_uring_submit_and_wait_timeout() function submits the next events to the submission
queue belonging to the
.I ring
and waits for
.I wait_nr
completion events or until the timeout
.I ts
expires.The completion events are stored in the
.I cqe_ptr array.
The
.I 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(),
prepares the SQE, it can be submitted with io_uring_submit_and_wait_timeout().


.SH RETURN VALUE
On success
.BR io_uring_submit_and_wait_timeout (3)
returns the number of submitted submission queue entries. On failure it returns -errno.
.SH SEE ALSO
.BR io_uring_get_sqe (3),  io_uring_submit (3), io_uring_submit_and_wait (3), io_uring_wait_cqe (3)