summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorJens Axboe <axboe@kernel.dk>2019-09-21 14:44:57 -0600
committerJens Axboe <axboe@kernel.dk>2019-09-21 14:44:57 -0600
commit8b93cca24b51e4a9be628c8bfde03399640e5ae6 (patch)
tree3b8272ce66e1451ff713296b89be07118607d694 /src
parent97690231261f38a97f26c2cffbdeae501faa7ae8 (diff)
downloadliburing-8b93cca24b51e4a9be628c8bfde03399640e5ae6.tar.gz
liburing-8b93cca24b51e4a9be628c8bfde03399640e5ae6.tar.bz2
io_uring_wait_cqe_timeout: document that io_uring_submit() not needed
We call this internally after queueing the timeout SQE anyway, so the application doesn't have to do it upfront. Signed-off-by: Jens Axboe <axboe@kernel.dk>
Diffstat (limited to 'src')
-rw-r--r--src/queue.c3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/queue.c b/src/queue.c
index 32e9857..8f0a1e4 100644
--- a/src/queue.c
+++ b/src/queue.c
@@ -65,6 +65,9 @@ int io_uring_wait_cqe(struct io_uring *ring, struct io_uring_cqe **cqe_ptr)
* Like io_uring_wait_cqe(), except it accepts a timeout value as well. Note
* that an sqe is used internally to handle the timeout. Applications using
* this function must never set sqe->user_data to LIBURING_UDATA_TIMEOUT!
+ *
+ * Note that the application need not call io_uring_submit() before calling
+ * this function, as we will do that on its behalf.
*/
int io_uring_wait_cqe_timeout(struct io_uring *ring,
struct io_uring_cqe **cqe_ptr,