aboutsummaryrefslogtreecommitdiff
path: root/man/io_uring_sqe_set_data.3
blob: f7ac5133fe7b88d71125c22200ffaa8158162315 (plain)
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
.\" Copyright (C) 2021 Stefan Roesch <shr@fb.com>
.\"
.\" SPDX-License-Identifier: LGPL-2.0-or-later
.\"
.TH io_uring_sqe_set_data 3 "November 15, 2021" "liburing-2.1" "liburing Manual"
.SH NAME
io_uring_sqe_set_data \- set user data for submission queue event
.SH SYNOPSIS
.nf
.B #include <liburing.h>
.PP
.BI "void io_uring_sqe_set_data(struct io_uring_sqe *" sqe ","
.BI "                           void *" user_data ");"
.fi
.SH DESCRIPTION
.PP
The
.BR io_uring_sqe_set_data (3)
function stores a
.I user_data
pointer with the submission queue entry
.IR sqe .

After the caller has requested an submission queue entry (SQE) with io_uring_get_sqe(),
he can associate a data pointer with the SQE. Once the completion arrives, the
function io_uring_cqe_get_data() can be called to identify the user request.

.SH RETURN VALUE
None
.SH SEE ALSO
.BR io_uring_get_sqe (3),
.BR io_uring_cqe_get_data (3)