1io_uring_peek_cqe(3)            liburing Manual           io_uring_peek_cqe(3)
2
3
4

NAME

6       io_uring_peek_cqe - check if an io_uring completion event is available
7

SYNOPSIS

9       #include <liburing.h>
10
11       int io_uring_peek_cqe(struct io_uring *ring,
12                             struct io_uring_cqe **cqe_ptr);
13

DESCRIPTION

15       The  io_uring_peek_cqe(3)  function  returns  an IO completion from the
16       queue belonging to the ring param, if one is readily available. On suc‐
17       cessful return, cqe_ptr param is filled with a valid CQE entry.
18
19       This  function does not enter the kernel to wait for an event, an event
20       is only returned if it's already available in the CQ ring.
21
22

RETURN VALUE

24       On success io_uring_peek_cqe(3) returns 0 and the cqe_ptr parameter  is
25       filled in. On failure it returns -EAGAIN.
26

SEE ALSO

28       io_uring_submit(3), io_uring_wait_cqes(3), io_uring_wait_cqe(3)
29
30
31
32liburing-2.2                    March 12, 2022            io_uring_peek_cqe(3)