openharmony/third_party_liburing
1
0
Fork 0
mirror of https://github.com/openharmony/third_party_liburing.git synced 2026-07-20 22:58:41 -04:00
Code Issues Packages Projects Releases Wiki Activity

man/io_uring_prep_accept.3: add man info for multishot accept

Browse Source 
Add man info for multishot accept APIs, including non-direct and direct.

Signed-off-by: Hao Xu <howeyxu@tencent.com>
Link: https://lore.kernel.org/r/20220514143534.59162-7-haoxu.linux@gmail.com
Signed-off-by: Jens Axboe <axboe@kernel.dk>
This commit is contained in:
Hao Xu
2022-05-14 22:35:34 +08:00
committed by Jens Axboe
parent 6c1250831c
commit 2a4e487b9c
3 changed files with 44 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
man/io_uring_prep_accept.3
+42 -9
View File
@@ -18,11 +18,23 @@ io_uring_prep_accept - prepare an accept request
.BI " int " flags ");"
.BI "
.BI "void io_uring_prep_accept_direct(struct io_uring_sqe *" sqe ","
.BI " int " sockfd ","
.BI " struct sockaddr *" addr ","
.BI " socklen_t " addrlen ","
.BI " int " flags ","
.BI " unsigned int " file_index ");"
.BI " int " sockfd ","
.BI " struct sockaddr *" addr ","
.BI " socklen_t " addrlen ","
.BI " int " flags ","
.BI " unsigned int " file_index ");"
.BI "
.BI "void io_uring_prep_multishot_accept(struct io_uring_sqe *" sqe ","
.BI " int " sockfd ","
.BI " struct sockaddr *" addr ","
.BI " socklen_t " addrlen ","
.BI " int " flags ");"
.BI "
.BI "void io_uring_prep_multishot_accept_direct(struct io_uring_sqe *" sqe ","
.BI " int " sockfd ","
.BI " struct sockaddr *" addr ","
.BI " socklen_t " addrlen ","
.BI " int " flags ");"
.PP
.SH DESCRIPTION
.PP
@@ -72,6 +84,25 @@ CQE
.I res
return.
For a direct descriptor accept request, the
.I file_index
argument can be set to
.B IORING_FILE_INDEX_ALLOC
In this case a free entry in io_uring file table will
be used automatically and the file index will be returned as CQE
.I res.
.B -ENFILE
is otherwise returned if there is no free entries in the io_uring file table.
The multishot version accept and accept_direct perform a bit different with the
normal ones. Users only need to issue one this kind of request to listen all
the comming fds, each fd accepted is returned in a CQE. One thing to notice is
io_uring_prep_multishot_accept_direct() only works in
.B IORING_FILE_INDEX_ALLOC
mode, which means the CQE
.I res
returned is a file index counted from 1 not a real fd.
This function prepares an async
.BR accept4 (2)
request. See that man page for details.
@@ -81,12 +112,14 @@ None
.SH ERRORS
The CQE
.I res
field will contain the result of the operation. While the non-direct accept
returns the installed file descriptor as its value, the direct accept
returns
field will contain the result of the operation. For singleshot accept,the
non-direct accept returns the installed file descriptor as its value, the
direct accept returns
.B 0
on success. The caller must know which direct descriptor was picked for this
request. See the related man page for details on possible values for the
request. For multishot accept, the non-direct accept returns the installed
file descriptor as its value, the direct accept returns the file index used on
success. See the related man page for details on possible values for the
non-direct accept. Note that where synchronous system calls will return
.B -1
on failure and set
man/io_uring_prep_multishot_accept.3
Symlink
+1
View File
@@ -0,0 +1 @@
io_uring_prep_accept.3
man/io_uring_prep_multishot_accept_direct.3
Symlink
+1
View File
@@ -0,0 +1 @@
io_uring_prep_accept.3