xref: /dflybsd-src/lib/librt/aio_error.3 (revision 98b3d9adc9c22415cb65dea171616322211baa7a)
1d5c710e6SSascha Wildner.\" Copyright (c) 1999 Softweyr LLC.
2d5c710e6SSascha Wildner.\" All rights reserved.
3d5c710e6SSascha Wildner.\"
4d5c710e6SSascha Wildner.\" Redistribution and use in source and binary forms, with or without
5d5c710e6SSascha Wildner.\" modification, are permitted provided that the following conditions
6d5c710e6SSascha Wildner.\" are met:
7d5c710e6SSascha Wildner.\" 1. Redistributions of source code must retain the above copyright
8d5c710e6SSascha Wildner.\"    notice, this list of conditions and the following disclaimer.
9d5c710e6SSascha Wildner.\" 2. Redistributions in binary form must reproduce the above copyright
10d5c710e6SSascha Wildner.\"    notice, this list of conditions and the following disclaimer in the
11d5c710e6SSascha Wildner.\"    documentation and/or other materials provided with the distribution.
12d5c710e6SSascha Wildner.\"
13d5c710e6SSascha Wildner.\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND
14d5c710e6SSascha Wildner.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15d5c710e6SSascha Wildner.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16d5c710e6SSascha Wildner.\" ARE DISCLAIMED.  IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE
17d5c710e6SSascha Wildner.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18d5c710e6SSascha Wildner.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19d5c710e6SSascha Wildner.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20d5c710e6SSascha Wildner.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21d5c710e6SSascha Wildner.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22d5c710e6SSascha Wildner.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23d5c710e6SSascha Wildner.\" SUCH DAMAGE.
24d5c710e6SSascha Wildner.\"
25d5c710e6SSascha Wildner.\" $FreeBSD: src/lib/libc/sys/aio_error.2,v 1.6.2.6 2001/12/14 18:34:00 ru Exp $
26d5c710e6SSascha Wildner.\"
27d5c710e6SSascha Wildner.Dd June 2, 1999
28d5c710e6SSascha Wildner.Dt AIO_ERROR 3
29d5c710e6SSascha Wildner.Os
30d5c710e6SSascha Wildner.Sh NAME
31d5c710e6SSascha Wildner.Nm aio_error
32d5c710e6SSascha Wildner.Nd retrieve error status of asynchronous I/O operation (REALTIME)
33d5c710e6SSascha Wildner.Sh LIBRARY
34d5c710e6SSascha Wildner.Lb librt
35d5c710e6SSascha Wildner.Sh SYNOPSIS
36d5c710e6SSascha Wildner.In aio.h
37d5c710e6SSascha Wildner.Ft int
38d5c710e6SSascha Wildner.Fn aio_error "const struct aiocb *iocb"
39d5c710e6SSascha Wildner.Sh DESCRIPTION
40d5c710e6SSascha WildnerThe
41d5c710e6SSascha Wildner.Fn aio_error
42d5c710e6SSascha Wildnerfunction returns the error status of the asynchronous I/O request
43d5c710e6SSascha Wildnerassociated with the structure pointed to by
44d5c710e6SSascha Wildner.Fa iocb .
45d5c710e6SSascha Wildner.Sh RETURN VALUES
46d5c710e6SSascha WildnerIf the asynchronous I/O request has completed successfully,
47d5c710e6SSascha Wildner.Fn aio_error
485fda1bb4SSascha Wildnerreturns 0.
495fda1bb4SSascha WildnerIf the request has not yet completed,
50d5c710e6SSascha Wildner.Er EINPROGRESS
515fda1bb4SSascha Wildneris returned.
525fda1bb4SSascha WildnerIf the request has completed unsuccessfully the error
53d5c710e6SSascha Wildnerstatus is returned as described in
54d5c710e6SSascha Wildner.Xr read 2 ,
55d5c710e6SSascha Wildner.Xr write 2 ,
56d5c710e6SSascha Wildneror
57d5c710e6SSascha Wildner.Xr fsync 2
58d5c710e6SSascha Wildneris returned.
59d5c710e6SSascha WildnerOn failure,
60d5c710e6SSascha Wildner.Fn aio_error
61d5c710e6SSascha Wildnerreturns
62d5c710e6SSascha Wildner.Dv -1
63d5c710e6SSascha Wildnerand sets
64d5c710e6SSascha Wildner.Va errno
65d5c710e6SSascha Wildnerto indicate the error condition.
66d5c710e6SSascha Wildner.Sh ERRORS
67d5c710e6SSascha WildnerThe
68d5c710e6SSascha Wildner.Fn aio_error
69d5c710e6SSascha Wildnerfunction will fail if:
70d5c710e6SSascha Wildner.Bl -tag -width Er
71d5c710e6SSascha Wildner.It Bq Er EINVAL
72d5c710e6SSascha Wildner.Fa iocb
73d5c710e6SSascha Wildnerdoes not reference an outstanding asynchronous I/O request.
74d5c710e6SSascha Wildner.El
75d5c710e6SSascha Wildner.Sh SEE ALSO
76d5c710e6SSascha Wildner.Xr fsync 2 ,
77d5c710e6SSascha Wildner.Xr read 2 ,
78aebd4e04SSascha Wildner.Xr write 2 ,
79aebd4e04SSascha Wildner.Xr aio_cancel 3 ,
80aebd4e04SSascha Wildner.Xr aio_read 3 ,
81aebd4e04SSascha Wildner.Xr aio_return 3 ,
82aebd4e04SSascha Wildner.Xr aio_suspend 3 ,
83aebd4e04SSascha Wildner.Xr aio_write 3
84d5c710e6SSascha Wildner.Sh STANDARDS
85d5c710e6SSascha Wildner.Fn aio_error
86d5c710e6SSascha Wildneris expected to conform to the
87d5c710e6SSascha Wildner.St -p1003.2
88d5c710e6SSascha Wildnerstandard.
89d5c710e6SSascha Wildner.Sh HISTORY
90d5c710e6SSascha WildnerThe
91d5c710e6SSascha Wildner.Nm
92d5c710e6SSascha Wildnerfunction first appeared in
93d5c710e6SSascha Wildner.Fx 3.0 .
94d5c710e6SSascha Wildner.Sh AUTHORS
95d5c710e6SSascha WildnerThis
96d5c710e6SSascha Wildnermanual page was written by
97*98b3d9adSFranco Fichtner.An Wes Peters Aq Mt wes@softweyr.com .
98