logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

aio_return.3p (3434B)

    

  1. '\" et
  2. .TH AIO_RETURN "3P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. aio_return
  12. \(em retrieve return status of an asynchronous I/O operation
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <aio.h>
  17. .P
  18. ssize_t aio_return(struct aiocb *\fIaiocbp\fP);
  19. .fi
  20. .SH DESCRIPTION
  21. The
  22. \fIaio_return\fR()
  23. function shall return the return status associated with the
  24. .BR aiocb
  25. structure referenced by the
  26. .IR aiocbp
  27. argument. The return status for an asynchronous I/O operation is the
  28. value that would be returned by the corresponding
  29. \fIread\fR(),
  30. \fIwrite\fR(),
  31. or
  32. \fIfsync\fR()
  33. function call. If the error status for the operation is equal to
  34. .BR [EINPROGRESS] ,
  35. then the return status for the operation is undefined. The
  36. \fIaio_return\fR()
  37. function may be called exactly once to retrieve the return status of a
  38. given asynchronous operation; thereafter, if the same
  39. .BR aiocb
  40. structure is used in a call to
  41. \fIaio_return\fR()
  42. or
  43. \fIaio_error\fR(),
  44. an error may be returned. When the
  45. .BR aiocb
  46. structure referred to by
  47. .IR aiocbp
  48. is used to submit another asynchronous operation, then
  49. \fIaio_return\fR()
  50. may be successfully used to retrieve the return status of that
  51. operation.
  52. .SH "RETURN VALUE"
  53. If the asynchronous I/O operation has completed, then the return
  54. status, as described for
  55. \fIread\fR(),
  56. \fIwrite\fR(),
  57. and
  58. \fIfsync\fR(),
  59. shall be returned. If the asynchronous I/O operation has not yet
  60. completed, the results of
  61. \fIaio_return\fR()
  62. are undefined.
  63. .P
  64. If the
  65. \fIaio_return\fR()
  66. function fails, it shall return \-1 and set
  67. .IR errno
  68. to indicate the error.
  69. .SH ERRORS
  70. The
  71. \fIaio_return\fR()
  72. function may fail if:
  73. .TP
  74. .BR EINVAL
  75. The
  76. .IR aiocbp
  77. argument does not refer to an asynchronous operation whose return
  78. status has not yet been retrieved.
  79. .LP
  80. .IR "The following sections are informative."
  81. .SH EXAMPLES
  82. None.
  83. .SH "APPLICATION USAGE"
  84. None.
  85. .SH RATIONALE
  86. None.
  87. .SH "FUTURE DIRECTIONS"
  88. None.
  89. .SH "SEE ALSO"
  90. .IR "\fIaio_cancel\fR\^(\|)",
  91. .IR "\fIaio_error\fR\^(\|)",
  92. .IR "\fIaio_fsync\fR\^(\|)",
  93. .IR "\fIaio_read\fR\^(\|)",
  94. .IR "\fIaio_write\fR\^(\|)",
  95. .IR "\fIclose\fR\^(\|)",
  96. .IR "\fIexec\fR\^",
  97. .IR "\fIexit\fR\^(\|)",
  98. .IR "\fIfork\fR\^(\|)",
  99. .IR "\fIlio_listio\fR\^(\|)",
  100. .IR "\fIlseek\fR\^(\|)",
  101. .IR "\fIread\fR\^(\|)"
  102. .P
  103. The Base Definitions volume of POSIX.1\(hy2017,
  104. .IR "\fB<aio.h>\fP"
  105. .\"
  106. .SH COPYRIGHT
  107. Portions of this text are reprinted and reproduced in electronic form
  108. from IEEE Std 1003.1-2017, Standard for Information Technology
  109. -- Portable Operating System Interface (POSIX), The Open Group Base
  110. Specifications Issue 7, 2018 Edition,
  111. Copyright (C) 2018 by the Institute of
  112. Electrical and Electronics Engineers, Inc and The Open Group.
  113. In the event of any discrepancy between this version and the original IEEE and
  114. The Open Group Standard, the original IEEE and The Open Group Standard
  115. is the referee document. The original Standard can be obtained online at
  116. http://www.opengroup.org/unix/online.html .
  117. .PP
  118. Any typographical or formatting errors that appear
  119. in this page are most likely
  120. to have been introduced during the conversion of the source files to
  121. man page format. To report such errors, see
  122. https://www.kernel.org/doc/man-pages/reporting_bugs.html .