public inbox for [email protected]
 help / color / mirror / Atom feed
From: Ammar Faizi <[email protected]>
To: Jens Axboe <[email protected]>
Cc: io-uring Mailing List <[email protected]>,
	Pavel Begunkov <[email protected]>,
	"David S . Miller" <[email protected]>,
	Jakub Kicinski <[email protected]>,
	[email protected], [email protected],
	Nugra <[email protected]>, Ammar Faizi <[email protected]>
Subject: [RFC PATCH liburing v1 5/5] man: Add `io_uring_prep_{sendto,recvfrom}` docs
Date: Fri, 31 Dec 2021 00:50:19 +0700	[thread overview]
Message-ID: <[email protected]> (raw)
In-Reply-To: <[email protected]>

From: Nugra <[email protected]>

Cc: Ammar Faizi <[email protected]>
Signed-off-by: Nugra <[email protected]>
Signed-off-by: Ammar Faizi <[email protected]>
---
 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 <[email protected]>
+.\"
+.\" 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 <[email protected]>
+.\"
+.\" 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


      parent reply	other threads:[~2021-12-30 17:51 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-12-30 17:50 [RFC PATCH liburing v1 0/5] liburing: Add sendto(2) and recvfrom(2) support Ammar Faizi
2021-12-30 17:50 ` [RFC PATCH liburing v1 1/5] .gitignore: Add `/test/xattr` and `/test/getdents` Ammar Faizi
2021-12-30 17:50 ` [RFC PATCH liburing v1 2/5] io_uring.h: Add `IORING_OP_SENDTO` and `IORING_OP_RECVFROM` Ammar Faizi
2021-12-30 17:50 ` [RFC PATCH liburing v1 3/5] liburing.h: Add `io_uring_prep_{sendto,sendto}` helper Ammar Faizi
2021-12-30 17:50 ` [RFC PATCH liburing v1 4/5] test: Add sendto_recvfrom test program Ammar Faizi
2021-12-30 17:50 ` Ammar Faizi [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    [email protected] \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox