File: io_uring_cq_eventfd_enabled.3

package info (click to toggle)
liburing 2.14-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 3,448 kB
  • sloc: ansic: 59,512; sh: 816; makefile: 603; cpp: 32
file content (38 lines) | stat: -rw-r--r-- 1,026 bytes parent folder | download
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
.\" Copyright (C) 2025 Jens Axboe <axboe@kernel.dk>
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_cq_eventfd_enabled 3 "January 18, 2025" "liburing-2.4" "liburing Manual"
.SH NAME
io_uring_cq_eventfd_enabled \- check if eventfd notifications are enabled
.SH SYNOPSIS
.nf
.B #include <liburing.h>
.PP
.BI "bool io_uring_cq_eventfd_enabled(const struct io_uring *" ring ");"
.fi
.SH DESCRIPTION
.PP
The
.BR io_uring_cq_eventfd_enabled (3)
function returns whether eventfd notifications are currently enabled for
the io_uring instance specified by
.IR ring .

An eventfd can be registered with a ring using
.BR io_uring_register_eventfd (3)
or
.BR io_uring_register_eventfd_async (3).
Once registered, notifications can be temporarily disabled using
.BR io_uring_cq_eventfd_toggle (3).

.SH RETURN VALUE
Returns
.B true
if eventfd notifications are enabled, or
.B false
if disabled.
.SH SEE ALSO
.BR io_uring_register_eventfd (3),
.BR io_uring_register_eventfd_async (3),
.BR io_uring_cq_eventfd_toggle (3)