[RFC PATCH liburing v1 5/5] man: Add `io_uring_prep_{sendto,recvfrom}` docs
flat view
DORMANTno replies
From: Ammar Faizi <hidden>
Date: 2021-12-30 17:51:08
Also in:
io-uring, lkml
Subsystem:
the rest · Maintainer:
Linus Torvalds
From: Nugra <redacted> Cc: Ammar Faizi <redacted> Signed-off-by: Nugra <redacted> Signed-off-by: Ammar Faizi <redacted> --- man/io_uring_prep_recvfrom.3 | 33 +++++++++++++++++++++++++++++++++ man/io_uring_prep_sendto.3 | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 67 insertions(+) create mode 100644 man/io_uring_prep_recvfrom.3 create mode 100644 man/io_uring_prep_sendto.3
diff --git a/man/io_uring_prep_recvfrom.3 b/man/io_uring_prep_recvfrom.3
new file mode 100644
index 0000000..b6cfea7
--- /dev/null
+++ b/man/io_uring_prep_recvfrom.3@@ -0,0 +1,33 @@ +.\" Copyright (C) 2021 Nugra <richiisei@gmail.com> +.\" +.\" SPDX-License-Identifier: LGPL-2.0-or-later +.\" +.TH io_uring_prep_recvfrom 3 "December 30, 2021" "liburing-2.1" "liburing Manual" +.SH NAME +io_uring_prep_recvfrom - prepare I/O recvfrom request + +.SH SYNOPSIS +.nf +.BR "#include <liburing.h>" +.PP +.BI "void io_uring_prep_recvfrom(struct io_uring_sqe *sqe, int sockfd," +.BI " void *buf, size_t len, int flags, +.BI " struct sockaddr *src_addr," +.BI " socklen_t *addrlen)" +.SH DESCRIPTION +The io_uring_prep_recvfrom() prepares receive messages from a socket. The submission queue entry +.I sqe +is setup to use the file descriptor +.I fd +transmit the request. + +After the submission queue entry +.I sqe +has been prepared as +.I recvfrom +op, it can be submitted with one of the submit functions. + +.SH RETURN VALUE +None +.SH SEE ALSO +.BR io_uring_get_sqe (3), io_uring_submit (3)
diff --git a/man/io_uring_prep_sendto.3 b/man/io_uring_prep_sendto.3
new file mode 100644
index 0000000..2ed8263
--- /dev/null
+++ b/man/io_uring_prep_sendto.3@@ -0,0 +1,34 @@ +.\" Copyright (C) 2021 Nugra <richiisei@gmail.com> +.\" +.\" SPDX-License-Identifier: LGPL-2.0-or-later +.\" +.TH io_uring_prep_sendto 3 "December 30, 2021" "liburing-2.1" "liburing Manual" +.SH NAME +io_uring_prep_sendto - prepare I/O sendto request + +.SH SYNOPSIS +.nf +.BR "#include <liburing.h>" +.PP +.BI "void io_uring_prep_sendto(struct io_uring_sqe *sqe, int sockfd," +.BI " const void *buf, size_t len, int flags," +.BI " const struct sockaddr *dest_addr," +.BI " socklen_t addrlen)" +.PP +.SH DESCRIPTION +The io_uring_prep_sendto() prepares transmit request to another socket. The submission queue entry +.I sqe +is setup to use the file descriptor +.I fd +transmit the request. + +After the submission queue entry +.I sqe +has been prepared as +.I sendto +op, it can be submitted with one of the submit functions. + +.SH RETURN VALUE +None +.SH SEE ALSO +.BR io_uring_get_sqe (3), io_uring_submit (3)
--
2.32.0