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