summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authorwes <wes@FreeBSD.org>1999-09-20 18:30:55 +0000
committerwes <wes@FreeBSD.org>1999-09-20 18:30:55 +0000
commitfc37cb4477bba08aea4231ee32f6ec9a9275f199 (patch)
treeda80da0ca061d1c1e684bbc2484d05a12146b9e7 /lib
parentbeea8c578659a0aa0f59a617bfb1cc980614561f (diff)
downloadFreeBSD-src-fc37cb4477bba08aea4231ee32f6ec9a9275f199.zip
FreeBSD-src-fc37cb4477bba08aea4231ee32f6ec9a9275f199.tar.gz
Fixed the description of when and why aio_suspend returns.
Also spelled out the return values and conditions a little better. Noticed by: John Polstra <jdp@polstra.com>
Diffstat (limited to 'lib')
-rw-r--r--lib/libc/sys/aio_suspend.226
1 files changed, 15 insertions, 11 deletions
diff --git a/lib/libc/sys/aio_suspend.2 b/lib/libc/sys/aio_suspend.2
index ca416b7..4b4cc79 100644
--- a/lib/libc/sys/aio_suspend.2
+++ b/lib/libc/sys/aio_suspend.2
@@ -37,24 +37,24 @@
.Sh DESCRIPTION
The
.Fn aio_suspend
-function suspends the calling process until all of the specified
-asynchronous I/O requests have completed or the
+function suspends the calling process until at least one of the
+specified asynchronous I/O requests have completed, a signal is
+delivered, or the
.Ar timeout
has passed.
+.Pp
.Ar iocbs
is an array of
.Ar niocb
-pointers to asynchronous I/O requests. Array members containing NULL
-will be silently ignored.
+pointers to asynchronous I/O requests. Array members containing
+NULL will be silently ignored.
.Sh RETURN VALUES
-If all of the specified asynchronous I/O requests have completed,
+If one or more of the specified asynchronous I/O requests have
+completed,
.Fn aio_suspend
-returns 0. If the
-.Ar timeout
-expired,
-.Dv EAGAIN
-is returned. Other return values indicate an error condition as
-detailed below.
+returns 0. Otherwise it returns -1 and sets
+.Va errno
+to indicate the error, as enumerated below.
.Sh SEE ALSO
.Xr aio_cancel 2 ,
.Xr aio_error 2 ,
@@ -66,6 +66,10 @@ The
.Fn aio_suspend
function will fail if:
.Bl -tag -width Er
+.It Bq Er EAGAIN
+the
+.Ar timeout
+expired before any I/O requests completed.
.It Bq Er EINVAL
.Ar iocbs
contains more than
OpenPOWER on IntegriCloud