summaryrefslogtreecommitdiff
path: root/man/io_uring_cqe_seen.3
blob: dc7f8e41ec5d748255f03b302964a5cd177711d1 (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
.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_cqe_seen 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_cqe_seen - Mark io_uring completion event as processed
.SH SYNOPSIS
.nf
.BR "#include <liburing.h>"
.PP
.BI "void io_uring_cqe_seen(struct io_uring *" ring ","
.BI "                       struct io_uring_cqe *" cqe ");"
.fi
.PP
.SH DESCRIPTION
.PP
The io_uring_cqe_seen() function marks the IO completion
.I cqe
belonging to the
.I ring
param as processed.

After the caller has submitted a request with
.BR io_uring_submit (3),
the application can retrieve the completion with
.BR io_uring_wait_cqe (3),
.BR io_uring_peek_cqe (3),
or any of the other CQE retrieval helpers, and mark it as processed with
.BR io_uring_cqe_seen (3).

Completions must be marked as completed, so their slot can get reused.
.SH RETURN VALUE
None
.SH SEE ALSO
.BR io_uring_submit (3), io_uring_wait_cqe (3), io_uring_peek_cqe (3), io_uring_wait_cqes (3), io_uring_wait_cqe_timeout (3), io_uring_cqe_seen (3)