diff options
| author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | 2023-07-07 05:12:36 +0000 |
|---|---|---|
| committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | 2023-07-07 05:12:36 +0000 |
| commit | 04d90211ecab6b0ddadadcf6c182f4607b9b72a8 (patch) | |
| tree | ebe9c872e416346e4b333e5062da32401c8e0a73 /man/io_uring_submit_and_wait_timeout.3 | |
| parent | d53db6851ea17b2d219d084e1afc683b8b62b105 (diff) | |
| parent | 1d27ff1934c5c4292dc00fba7f7f8ae411ed42f5 (diff) | |
| download | liburing-android14-mainline-uwb-release.tar.gz | |
Snap for 10453563 from 1d27ff1934c5c4292dc00fba7f7f8ae411ed42f5 to mainline-uwb-releaseaml_uwb_341710010aml_uwb_341513070aml_uwb_341511050aml_uwb_341310300aml_uwb_341310030aml_uwb_341111010aml_uwb_341011000android14-mainline-uwb-release
Change-Id: Ic34ca4f84d38b3a9593603ab4791da9a91806588
Diffstat (limited to 'man/io_uring_submit_and_wait_timeout.3')
| -rw-r--r-- | man/io_uring_submit_and_wait_timeout.3 | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/man/io_uring_submit_and_wait_timeout.3 b/man/io_uring_submit_and_wait_timeout.3 new file mode 100644 index 0000000..80fe889 --- /dev/null +++ b/man/io_uring_submit_and_wait_timeout.3 @@ -0,0 +1,54 @@ +.\" 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 +.SH SYNOPSIS +.nf +.B #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 ");" +.fi +.SH DESCRIPTION +.PP +The +.BR io_uring_submit_and_wait_timeout (3) +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 +.BR io_uring_get_sqe (3) +and prepares the SQE, it can be submitted with +.BR io_uring_submit_and_wait_timeout (3) . + +.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 +.BR -errno . +The most common failure case is not receiving a completion within the specified +timeout, +.B -ETIME +is returned in this case. +.SH SEE ALSO +.BR io_uring_get_sqe (3), +.BR io_uring_submit (3), +.BR io_uring_submit_and_wait (3), +.BR io_uring_wait_cqe (3) |