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

NAME

6       io_uring_get_sqe  -  get the next available submission queue entry from
7       the submission queue
8

SYNOPSIS

10       #include <liburing.h>
11
12       struct io_uring_sqe *io_uring_get_sqe(struct io_uring *ring);
13

DESCRIPTION

15       The io_uring_get_sqe(3) function gets  the  next  available  submission
16       queue entry from the submission queue belonging to the ring param.
17
18       On  success  io_uring_get_sqe(3)  returns  a  pointer to the submission
19       queue entry. On failure NULL is returned.
20
21       If a submission queue entry is returned, it should be  filled  out  via
22       one  of  the prep functions such as io_uring_prep_read(3) and submitted
23       via io_uring_submit(3).
24
25       Note that neither io_uring_get_sqe  nor  the  prep  functions  set  (or
26       clear)  the  user_data  field  of the SQE. If the caller expects io_ur‐
27       ing_cqe_get_data(3) or io_uring_cqe_get_data64(3) to return valid  data
28       when  reaping IO completions, either io_uring_sqe_set_data(3) or io_ur‐
29       ing_sqe_set_data64(3) MUST have been called before submitting  the  re‐
30       quest.
31
32

RETURN VALUE

34       io_uring_get_sqe(3)  returns  a  pointer  to  the next submission queue
35       event on success and NULL on failure. If NULL is returned, the SQ  ring
36       is  currently  full and entries must be submitted for processing before
37       new ones can get allocated.
38

SEE ALSO

40       io_uring_submit(3), io_uring_sqe_set_data(3)
41
42
43
44liburing-0.7                     July 10, 2020             io_uring_get_sqe(3)
Impressum