xref: /freebsd/lib/libsys/aio_error.2 (revision 5f757f3ff9144b609b3c433dfd370cc6bdc191ad)
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.Dd January 2, 2021
26.Dt AIO_ERROR 2
27.Os
28.Sh NAME
29.Nm aio_error
30.Nd retrieve error status of asynchronous I/O operation (REALTIME)
31.Sh LIBRARY
32.Lb libc
33.Sh SYNOPSIS
34.In aio.h
35.Ft int
36.Fn aio_error "const struct aiocb *iocb"
37.Sh DESCRIPTION
38The
39.Fn aio_error
40system call returns the error status of the asynchronous I/O request
41associated with the structure pointed to by
42.Fa iocb .
43.Sh RETURN VALUES
44If the asynchronous I/O request has completed successfully,
45.Fn aio_error
46returns 0.
47If the request has not yet completed,
48.Er EINPROGRESS
49is returned.
50If the request has completed unsuccessfully the error
51status is returned as described in
52.Xr read 2 ,
53.Xr readv 2 ,
54.Xr write 2 ,
55.Xr writev 2 ,
56or
57.Xr fsync 2 .
58On failure,
59.Fn aio_error
60returns
61.Dv -1
62and sets
63.Dv errno
64to indicate the error condition.
65.Sh ERRORS
66The
67.Fn aio_error
68system call will fail if:
69.Bl -tag -width Er
70.It Bq Er EINVAL
71The
72.Fa iocb
73argument
74does not reference an outstanding asynchronous I/O request.
75.El
76.Sh SEE ALSO
77.Xr aio_cancel 2 ,
78.Xr aio_read 2 ,
79.Xr aio_readv 2 ,
80.Xr aio_return 2 ,
81.Xr aio_suspend 2 ,
82.Xr aio_write 2 ,
83.Xr aio_writev 2 ,
84.Xr fsync 2 ,
85.Xr read 2 ,
86.Xr write 2 ,
87.Xr aio 4
88.Sh STANDARDS
89The
90.Fn aio_error
91system call
92is expected to conform to the
93.St -p1003.1
94standard.
95.Sh HISTORY
96The
97.Fn aio_error
98system call first appeared in
99.Fx 3.0 .
100.Sh AUTHORS
101This
102manual page was written by
103.An Wes Peters Aq Mt wes@softweyr.com .
104