projects / apple / xnu.git / blame
| Commit | Line | Data |
|---|---|---|
| 91447636 A |
1 | .\" Copyright (c) 1999 Softweyr LLC. |
| 2 | .\" All rights reserved. | |
| 3 | .\" | |
| 4 | .\" Redistribution and use in source and binary forms, with or without | |
| 5 | .\" modification, are permitted provided that the following conditions | |
| 6 | .\" are met: | |
| 7 | .\" 1. Redistributions of source code must retain the above copyright | |
| 8 | .\" notice, this list of conditions and the following disclaimer. | |
| 9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
| 10 | .\" notice, this list of conditions and the following disclaimer in the | |
| 11 | .\" documentation and/or other materials provided with the distribution. | |
| 12 | .\" | |
| 13 | .\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND | |
| 14 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
| 15 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
| 16 | .\" ARE DISCLAIMED. IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE | |
| 17 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
| 18 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
| 19 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
| 20 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
| 21 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
| 22 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
| 23 | .\" SUCH DAMAGE. | |
| 24 | .\" | |
| 25 | .\" $FreeBSD: src/lib/libc/sys/aio_return.2,v 1.17 2003/01/13 10:37:11 tjr Exp $ | |
| 26 | .\" | |
| 27 | .Dd June 2, 1999 | |
| 28 | .Dt AIO_RETURN 2 | |
| 29 | .Os | |
| 30 | .Sh NAME | |
| 31 | .Nm aio_return | |
| 32 | .Nd retrieve return status of asynchronous I/O operation (REALTIME) | |
| 33 | .Sh LIBRARY | |
| 34 | .Lb libc | |
| 35 | .Sh SYNOPSIS | |
| 36 | .In aio.h | |
| 37 | .Ft int | |
| 38 | .Fn aio_return "struct aiocb *iocb" | |
| 39 | .Sh DESCRIPTION | |
| 40 | The | |
| 41 | .Fn aio_return | |
| 42 | system call returns the final status of the asynchronous I/O request | |
| 43 | associated with the structure pointed to by | |
| 44 | .Fa iocb . | |
| 45 | .Pp | |
| 46 | The | |
| 47 | .Fn aio_return | |
| 48 | system call | |
| 49 | should only be called once, to obtain the final status of an asynchronous | |
| 50 | I/O operation once | |
| 51 | .Xr aio_error 2 | |
| 52 | returns something other than | |
| 53 | .Er EINPROGRESS . | |
| 54 | .Sh RETURN VALUES | |
| 55 | If the asynchronous I/O request has completed, the status is returned | |
| 56 | as described in | |
| 57 | .Xr read 2 , | |
| 58 | .Xr write 2 , | |
| 59 | or | |
| 60 | .Xr fsync 2 . | |
| 61 | On failure, | |
| 62 | .Fn aio_return | |
| 63 | returns | |
| 64 | .Dv -1 | |
| 65 | and sets | |
| 66 | .Dv errno | |
| 67 | to indicate the error condition. | |
| 68 | .Sh ERRORS | |
| 69 | The | |
| 70 | .Fn aio_return | |
| 71 | system call will fail if: | |
| 72 | .Bl -tag -width Er | |
| 73 | .It Bq Er EINVAL | |
| 74 | The | |
| 75 | .Fa iocb | |
| 76 | argument | |
| 77 | does not reference an outstanding asynchronous I/O request. | |
| 78 | .El | |
| 79 | .Sh SEE ALSO | |
| 80 | .Xr aio_cancel 2 , | |
| 81 | .Xr aio_error 2 , | |
| 82 | .Xr aio_suspend 2 , | |
| 83 | .Xr aio_write 2 , | |
| 84 | .Xr fsync 2 , | |
| 85 | .Xr read 2 , | |
| 86 | .Xr write 2 , | |
| 87 | .Xr aio 4 | |
| 88 | .Sh STANDARDS | |
| 89 | The | |
| 90 | .Fn aio_return | |
| 91 | system call | |
| 92 | is expected to conform to the | |
| 93 | .St -p1003.1 | |
| 94 | standard. | |
| 95 | .Sh HISTORY | |
| 96 | The | |
| 97 | .Fn aio_return | |
| 98 | system call first appeared in | |
| 99 | .Fx 3.0 . | |
| 100 | .Sh AUTHORS | |
| 101 | This | |
| 102 | manual page was written by | |
| 103 | .An Wes Peters Aq wes@softweyr.com . |