git.saurik.com Git - apple/xnu.git/blob - bsd/man/man2/aio

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_error.2,v 1.18 2003/01/13 10:37:11 tjr Exp $

26 .\"

27 .Dd June 2, 1999

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 .Fo aio_error

39 .Fa "const struct aiocb *aiocbp"

40 .Fc

41 .Sh DESCRIPTION

42 The

43 .Fn aio_error

44 system call returns the error status of the asynchronous I/O request

45 associated with the structure pointed to by

46 .Fa aiocbp .

47 .Sh RETURN VALUES

48 If the asynchronous I/O request has completed successfully,

49 .Fn aio_error

50 returns 0. If the request has not yet completed,

51 .Er EINPROGRESS

52 is returned.

53 If the request has completed unsuccessfully,

54 the error status is returned as described in

55 .Xr read 2 ,

56 .Xr write 2 ,

57 or

58 .Xr fsync 2

59 is returned.

60 On failure,

61 .Fn aio_error

62 returns

63 .Dv -1

64 and sets

65 .Dv errno

66 to indicate the error condition.

67 .Sh ERRORS

68 The

69 .Fn aio_error

70 system call will fail if:

71 .Bl -tag -width Er

72 .\" ==========

73 .It Bq Er EINVAL

74 The

75 .Fa aiocbp

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_read 2 ,

82 .Xr aio_return 2 ,

83 .Xr aio_suspend 2 ,

84 .Xr aio_write 2 ,

85 .Xr fsync 2 ,

86 .Xr read 2 ,

87 .Xr write 2 ,

88 .Xr aio 4

89 .Sh STANDARDS

90 The

91 .Fn aio_error

92 system call

93 is expected to conform to the

94 .St -p1003.1

95 standard.

96 .Sh HISTORY

97 The

98 .Fn aio_error

99 system call first appeared in

100 .Fx 3.0 .

101 .Sh AUTHORS

102 This

103 manual page was written by

104 .An Wes Peters Aq wes@softweyr.com .