[RFC,liburing,v1,2/2] man: Add `io_uring_prep_sendto()`

Commit Message

Ammar Faizi April 15, 2023, 4:58 p.m. UTC

Signed-off-by: Ammar Faizi <[e-mail]>
---
 CHANGELOG                  |  1 +
 man/io_uring_prep_send.3   | 31 +++++++++++++++++++++++++++++++
 man/io_uring_prep_sendto.3 |  1 +
 3 files changed, 33 insertions(+)
 create mode 120000 man/io_uring_prep_sendto.3

Patch

diff --git a/CHANGELOG b/CHANGELOG
index 85e02a280d4a7c45..71ca3919e114d858 100644
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -14,6 +14,7 @@  liburing-2.4 release
   io_uring_prep_openat2_direct(), io_uring_prep_msg_ring_fd(), and
   io_uring_prep_socket_direct() factor in being called with
   IORING_FILE_INDEX_ALLOC for allocating a direct descriptor.
+- Add io_uring_prep_sendto() function.
 
 liburing-2.3 release
 
diff --git a/man/io_uring_prep_send.3 b/man/io_uring_prep_send.3
index 3bdc96751ebfb230..b555ec3a8548c449 100644
--- a/man/io_uring_prep_send.3
+++ b/man/io_uring_prep_send.3
@@ -14,6 +14,14 @@  io_uring_prep_send \- prepare a send request
 .BI "                        const void *" buf ","
 .BI "                        size_t " len ","
 .BI "                        int " flags ");"
+.PP
+.BI "void io_uring_prep_sendto(struct io_uring_sqe *" sqe ","
+.BI "                          int " sockfd ","
+.BI "                          const void *" buf ","
+.BI "                          size_t " len ","
+.BI "                          int " flags ","
+.BI "                          const struct sockaddr *" addr ","
+.BI "                          socklen_t " addrlen ");"
 .fi
 .SH DESCRIPTION
 .PP
@@ -43,6 +51,28 @@  This function prepares an async
 .BR send (2)
 request. See that man page for details.
 
+The
+.BR io_uring_prep_sendto (3)
+function prepares a sendto request. The submission queue entry
+.I sqe
+is setup to use the file descriptor
+.I sockfd
+to start sending the data from
+.I buf
+of size
+.I len
+bytes and with modifier flags
+.IR flags .
+The destination address is specified by
+.I addr
+and
+.I addrlen
+and must be a valid address for the socket type.
+
+This function prepares an async
+.BR sendto (2)
+request. See that man page for details.
+
 .SH RETURN VALUE
 None
 .SH ERRORS
@@ -64,3 +94,4 @@  field.
 .BR io_uring_get_sqe (3),
 .BR io_uring_submit (3),
 .BR send (2)
+.BR sendto (2)
diff --git a/man/io_uring_prep_sendto.3 b/man/io_uring_prep_sendto.3
new file mode 120000
index 0000000000000000..ba85e68453fe6dcb
--- /dev/null
+++ b/man/io_uring_prep_sendto.3
@@ -0,0 +1 @@ 
+io_uring_prep_send.3
\ No newline at end of file