summaryrefslogtreecommitdiffstats
path: root/lib/libc/sys/aio_suspend.2
diff options
context:
space:
mode:
Diffstat (limited to 'lib/libc/sys/aio_suspend.2')
-rw-r--r--lib/libc/sys/aio_suspend.292
1 files changed, 92 insertions, 0 deletions
diff --git a/lib/libc/sys/aio_suspend.2 b/lib/libc/sys/aio_suspend.2
new file mode 100644
index 0000000..01c635c
--- /dev/null
+++ b/lib/libc/sys/aio_suspend.2
@@ -0,0 +1,92 @@
+.\" Copyright (c) 1999 Softweyr LLC.
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\" notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\" notice, this list of conditions and the following disclaimer in the
+.\" documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED. IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.
+.\"
+.\" $Id$
+.\"
+.Dd June 2, 1999
+.Dt AIO_SUSPEND 2
+.Os
+.Sh NAME
+.Nm aio_suspend
+.Nd suspend until asynchronus I/O operations or timeout complete (REALTIME)
+.Sh SYNOPSIS
+.Fd #include <aio.h>
+.Ft int
+.Fn aio_suspend "const struct aiocb * const iocbs[]" "int niocb" "const struct timespec * timeout"
+.Sh DESCRIPTION
+The
+.Fn aio_suspend
+function suspends the calling process until all of the specified
+asynchronous I/O requests have completed or the
+.Ar timeout
+has passed.
+.Ar iocbs
+is an array of
+.Ar niocb
+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,
+.Fn aio_suspend
+returns 0. If the
+.Ar timeout
+expired,
+.Dv EAGAIN
+is returned. Other return values indicate an error condition as
+detailed below.
+.Sh SEE ALSO
+.Xr aio_error 2 ,
+.Xr aio_read 2 ,
+.Xr aio_write 2 ,
+.Xr aio_cancel 2 ,
+.Xr aio_suspend 2.
+.Sh ERRORS
+The
+.Fn aio_suspend
+function will fail if:
+.Bl -tag -width Er
+.It Bq Er EINVAL
+.Ar iocbs
+contains more than
+.Dv AIO_LISTIO_MAX aysynchronous I/O requests, or at least one
+of the requests is not valid.
+.It Bq Er EINTR
+the suspend was interrupted by a signal.
+.El
+.Sh STANDARDS
+.Fn aio_suspend
+is expected to conform to the
+.St -p1003.2
+standard.
+.Sh HISTORY
+The
+.Nm
+function first appeared in
+.Fx 3.0 .
+.Sh AUTHOR
+This
+manual page was written by
+.An Wes Peters Aq wes@softweyr.com .
+.Sh BUGS
+Have six legs.
OpenPOWER on IntegriCloud