xref: /aosp_15_r20/external/liburing/man/io_uring_get_sqe.3 (revision 25da2bea747f3a93b4c30fd9708b0618ef55a0e6)
Copyright (C) 2020 Jens Axboe <[email protected]>
Copyright (C) 2020 Red Hat, Inc.

SPDX-License-Identifier: LGPL-2.0-or-later

io_uring_get_sqe 3 "July 10, 2020" "liburing-0.7" "liburing Manual"
NAME
io_uring_get_sqe - get the next available submission queue entry from the submission queue
SYNOPSIS
 #include <liburing.h> 

"struct io_uring_sqe *io_uring_get_sqe(struct io_uring *" ring ");"

DESCRIPTION

The io_uring_get_sqe (3) function gets the next available submission queue entry from the submission queue belonging to the ring param. On success io_uring_get_sqe (3) returns a pointer to the submission queue entry. On failure NULL is returned. If a submission queue entry is returned, it should be filled out via one of the prep functions such as io_uring_prep_read (3) and submitted via io_uring_submit (3).

RETURN VALUE
io_uring_get_sqe (3) returns a pointer to the next submission queue event on success and NULL on failure. If NULL is returned, the SQ ring is currently full and entries must be submitted for processing before new ones can get allocated.
SEE ALSO
io_uring_submit (3)