diff options
author | wes <wes@FreeBSD.org> | 1999-07-01 19:58:12 +0000 |
---|---|---|
committer | wes <wes@FreeBSD.org> | 1999-07-01 19:58:12 +0000 |
commit | 4a9c6f5d1b372ec787c385c50a0cbcb632aeec30 (patch) | |
tree | ff6208a45b059fe7d85ebceed50157ad3b1d2e71 /lib/libc/sys/aio_return.2 | |
parent | f14aea7953bd22f80bc04b5b5f8a3100b4796611 (diff) | |
download | FreeBSD-src-4a9c6f5d1b372ec787c385c50a0cbcb632aeec30.zip FreeBSD-src-4a9c6f5d1b372ec787c385c50a0cbcb632aeec30.tar.gz |
Add mising aio_* man pages. Fixed a minor typo in aio_read.2,
and "corrected" statement of Posix conformance.
Diffstat (limited to 'lib/libc/sys/aio_return.2')
-rw-r--r-- | lib/libc/sys/aio_return.2 | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/lib/libc/sys/aio_return.2 b/lib/libc/sys/aio_return.2 new file mode 100644 index 0000000..82baae2 --- /dev/null +++ b/lib/libc/sys/aio_return.2 @@ -0,0 +1,97 @@ +.\" 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_RETURN 2 +.Os +.Sh NAME +.Nm aio_return +.Nd retrieve return status of asynchronus I/O operation (REALTIME) +.Sh SYNOPSIS +.Fd #include <aio.h> +.Ft int +.Fn aio_return "struct aiocb *iocb" +.Sh DESCRIPTION +The +.Fn aio_return +function returns the final status of the asynchronous I/O request +associated with the structure pointed to by +.Ar iocb . +.Pp +.Fn aio_return +should only be called once, to obtain the final status of an asynchronous +I/O operation once +.Xr aio_error 2 +returns something other than +.Dv EINPROGRESS . +.Sh RETURN VALUES +If the asynchronous I/O request has completed, the status is returned +as described in +.Xr read 2 , +.Xr write 2 , +or +.Xr fsync 2 . +On failure, +.Fn aio_return +returns +.Dv -1 +and sets +.Dv errno +to indicate the error condition. +.Sh SEE ALSO +.Xr aio_error 2 , +.Xr aio_read 2 , +.Xr aio_write 2 , +.Xr aio_cancel 2 , +.Xr aio_suspend 2 , +.Xr read 2 , +.Xr write 2 , +.Xr fsync 2 . +.Sh ERRORS +The +.Fn aio_return +function will fail if: +.Bl -tag -width Er +.It Bq Er EINVAL +.Ar iocb +does not reference an outstanding asynchronous I/O request. +.El +.Sh STANDARDS +.Fn aio_return +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 +Taste great! |