diff options
author | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | 2023-07-07 05:10:09 +0000 |
---|---|---|
committer | Android Build Coastguard Worker <android-build-coastguard-worker@google.com> | 2023-07-07 05:10:09 +0000 |
commit | b8f7e9523bba270978886a4377312b927e024620 (patch) | |
tree | ebe9c872e416346e4b333e5062da32401c8e0a73 /man/io_uring_peek_cqe.3 | |
parent | d53db6851ea17b2d219d084e1afc683b8b62b105 (diff) | |
parent | 1d27ff1934c5c4292dc00fba7f7f8ae411ed42f5 (diff) | |
download | liburing-android14-mainline-sdkext-release.tar.gz |
Snap for 10453563 from 1d27ff1934c5c4292dc00fba7f7f8ae411ed42f5 to mainline-sdkext-releaseaml_sdk_341710000aml_sdk_341510000aml_sdk_341410000aml_sdk_341110080aml_sdk_341110000aml_sdk_341010000aml_sdk_340912010android14-mainline-sdkext-release
Change-Id: Ifb21a10d7ab7ff789b497736136922bb8d723b0e
Diffstat (limited to 'man/io_uring_peek_cqe.3')
-rw-r--r-- | man/io_uring_peek_cqe.3 | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/man/io_uring_peek_cqe.3 b/man/io_uring_peek_cqe.3 new file mode 100644 index 0000000..a4ac2da --- /dev/null +++ b/man/io_uring_peek_cqe.3 @@ -0,0 +1,38 @@ +.\" Copyright (C) 2022 Jens Axboe <axboe@kernel.dk> +.\" +.\" SPDX-License-Identifier: LGPL-2.0-or-later +.\" +.TH io_uring_peek_cqe 3 "March 12, 2022" "liburing-2.2" "liburing Manual" +.SH NAME +io_uring_peek_cqe \- check if an io_uring completion event is available +.SH SYNOPSIS +.nf +.B #include <liburing.h> +.PP +.BI "int io_uring_peek_cqe(struct io_uring *" ring "," +.BI " struct io_uring_cqe **" cqe_ptr ");" +.fi +.SH DESCRIPTION +.PP +The +.BR io_uring_peek_cqe (3) +function returns an IO completion from the queue belonging to the +.I ring +param, if one is readily available. On successful return, +.I cqe_ptr +param is filled with a valid CQE entry. + +This function does not enter the kernel to wait for an event, an event +is only returned if it's already available in the CQ ring. + +.SH RETURN VALUE +On success +.BR io_uring_peek_cqe (3) +returns +.B 0 +and the cqe_ptr parameter is filled in. On failure it returns +.BR -EAGAIN . +.SH SEE ALSO +.BR io_uring_submit (3), +.BR io_uring_wait_cqes (3), +.BR io_uring_wait_cqe (3) |