|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|
|
NAME | SYNOPSIS | DESCRIPTION | Available commands | NOTES | RETURN VALUE | ERRORS | SEE ALSO | COLOPHON |
|
|
|
io_uring_prep_cmd(3) liburing Manual io_uring_prep_cmd(3)
io_uring_prep_cmd_sock - prepare a command request for a socket
#include <liburing.h>
void io_uring_prep_cmd_sock(struct io_uring_sqe *sqe,
int cmd_op,
int fd,
int level,
int optname,
void *optval,
int optlen);
The io_uring_prep_cmd_sock(3) function prepares an cmd request
for a socket. The submission queue entry sqe is setup to use the
socket file descriptor pointed to by fd to start an command
operation defined by cmd_op.
This is a generic function, and each command has their own
individual level, optname, optval values. The optlen defines the
size pointed by optval.
SOCKET_URING_OP_SIOCINQ
Returns the amount of queued unread data in the receive
buffer. The socket must not be in LISTEN state, otherwise
an error -EINVAL is returned in the CQE res field. The
following arguments are not used for this command level,
optname, optval and optlen.
Negative return value means an error.
For more information about this command, please check
unix(7).
SOCKET_URING_OP_SIOCOUTQ
Returns the amount of unsent data in the socket send
queue. The socket must not be in LISTEN state, otherwise
an error -EINVAL is returned in the CQE res. field. The
following arguments are not used for this command level,
optname, optval and optlen.
Negative return value means an error.
For more information about this command, please check
unix(7).
SOCKET_URING_OP_GETSOCKOPT
Command to get options for the socket referred to by the
socket file descriptor fd. The arguments are similar to
the getsockopt(2) system call.
The SOCKET_URING_OP_GETSOCKOPT command is limited to
SOL_SOCKET level.
Differently from the getsockopt(2) system call, the
updated optlen value is returned in the CQE res field, on
success. On failure, the CQE res contains a negative error
number.
SOCKET_URING_OP_SETSOCKOPT
Command to set options for the socket referred to by the
socket file descriptor fd. The arguments are similar to
the setsockopt(2) system call.
The memory block pointed by optval needs to be valid/live until
the CQE returns.
Dependent on the command.
The CQE res field will contain the result of the operation.
io_uring_get_sqe(3), io_uring_submit(3), io_uring_register(2),
unix(7)
This page is part of the liburing (A library for io_uring)
project. Information about the project can be found at
⟨https://github.com/axboe/liburing⟩. If you have a bug report for
this manual page, send it to [email protected]. This page
was obtained from the project's upstream Git repository
⟨https://github.com/axboe/liburing⟩ on 2024-06-14. (At that
time, the date of the most recent commit that was found in the
repository was 2024-06-03.) If you discover any rendering
problems in this HTML version of the page, or you believe there
is a better or more up-to-date source for the page, or you have
corrections or improvements to the information in this COLOPHON
(which is not part of the original manual page), send a mail to
[email protected]
liburing-2.5 July 27, 2023 io_uring_prep_cmd(3)
Pages that refer to this page: io_uring_prep_cmd(3)
|
HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH. |
|