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.h.0p (4729B)

    

  1. '\" et
  2. .TH aio.h "0P" 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.h
  12. \(em asynchronous input and output
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <aio.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <aio.h> 
  21. header shall define the
  22. .BR aiocb
  23. structure, which shall include at least the following members:
  24. .sp
  25. .RS 4
  26. .nf
  28. int             aio_fildes     \fRFile descriptor.\fR
  29. off_t           aio_offset     \fRFile offset.\fR
  30. volatile void  *aio_buf        \fRLocation of buffer.\fR
  31. size_t          aio_nbytes     \fRLength of transfer.\fR
  32. int             aio_reqprio    \fRRequest priority offset.\fR
  33. struct sigevent aio_sigevent   \fRSignal number and value.\fR
  34. int             aio_lio_opcode \fROperation to be performed.\fR
  35. .fi
  36. .P
  37. .RE
  38. .P
  39. The
  40. .IR <aio.h> 
  41. header shall define the
  42. .BR off_t ,
  43. .BR pthread_attr_t ,
  44. .BR size_t ,
  45. and
  46. .BR ssize_t
  47. types as described in
  48. .IR <sys/types.h> .
  49. .P
  50. The
  51. .IR <aio.h> 
  52. header shall define the
  53. .BR "struct timespec"
  54. structure as described in
  55. .IR <time.h> .
  56. .P
  57. The
  58. .IR <aio.h> 
  59. header shall define the
  60. .BR sigevent
  61. structure and
  62. .BR sigval
  63. union as described in
  64. .IR "\fB<signal.h>\fP".
  65. .P
  66. The
  67. .IR <aio.h> 
  68. header shall define the following symbolic constants:
  69. .IP AIO_ALLDONE 14
  70. A return value indicating that none of the requested operations could
  71. be canceled since they are already complete.
  72. .IP AIO_CANCELED 14
  73. A return value indicating that all requested operations have been
  74. canceled.
  75. .IP AIO_NOTCANCELED 14
  76. .br
  77. A return value indicating that some of the requested operations could
  78. not be canceled since they are in progress.
  79. .IP LIO_NOP 14
  80. A
  81. \fIlio_listio\fR()
  82. element operation option indicating that no transfer is requested.
  83. .IP LIO_NOWAIT 14
  84. A
  85. \fIlio_listio\fR()
  86. synchronization operation indicating that the calling thread is to
  87. continue execution while the
  88. \fIlio_listio\fR()
  89. operation is being performed, and no notification is given when the
  90. operation is complete.
  91. .IP LIO_READ 14
  92. A
  93. \fIlio_listio\fR()
  94. element operation option requesting a read.
  95. .IP LIO_WAIT 14
  96. A
  97. \fIlio_listio\fR()
  98. synchronization operation indicating that the calling thread is to
  99. suspend until the
  100. \fIlio_listio\fR()
  101. operation is complete.
  102. .IP LIO_WRITE 14
  103. A
  104. \fIlio_listio\fR()
  105. element operation option requesting a write.
  106. .P
  107. The following shall be declared as functions and may also be defined
  108. as macros. Function prototypes shall be provided.
  109. .sp
  110. .RS 4
  111. .nf
  113. int      aio_cancel(int, struct aiocb *);
  114. int      aio_error(const struct aiocb *);
  115. int      aio_fsync(int, struct aiocb *);
  116. int      aio_read(struct aiocb *);
  117. ssize_t  aio_return(struct aiocb *);
  118. int      aio_suspend(const struct aiocb *const [], int,
  119.              const struct timespec *);
  120. int      aio_write(struct aiocb *);
  121. int      lio_listio(int, struct aiocb *restrict const [restrict], int,
  122.              struct sigevent *restrict);
  123. .fi
  124. .P
  125. .RE
  126. .P
  127. Inclusion of the
  128. .IR <aio.h> 
  129. header may make visible symbols defined in the headers
  130. .IR <fcntl.h> ,
  131. .IR <signal.h> ,
  132. and
  133. .IR <time.h> .
  134. .LP
  135. .IR "The following sections are informative."
  136. .SH "APPLICATION USAGE"
  137. None.
  138. .SH RATIONALE
  139. None.
  140. .SH "FUTURE DIRECTIONS"
  141. None.
  142. .SH "SEE ALSO"
  143. .IR "\fB<fcntl.h>\fP",
  144. .IR "\fB<signal.h>\fP",
  145. .IR "\fB<sys_types.h>\fP",
  146. .IR "\fB<time.h>\fP"
  147. .P
  148. The System Interfaces volume of POSIX.1\(hy2017,
  149. .IR "\fIaio_cancel\fR\^(\|)",
  150. .IR "\fIaio_error\fR\^(\|)",
  151. .IR "\fIaio_fsync\fR\^(\|)",
  152. .IR "\fIaio_read\fR\^(\|)",
  153. .IR "\fIaio_return\fR\^(\|)",
  154. .IR "\fIaio_suspend\fR\^(\|)",
  155. .IR "\fIaio_write\fR\^(\|)",
  156. .IR "\fIfsync\fR\^(\|)",
  157. .IR "\fIlio_listio\fR\^(\|)",
  158. .IR "\fIlseek\fR\^(\|)",
  159. .IR "\fIread\fR\^(\|)",
  160. .IR "\fIwrite\fR\^(\|)"
  161. .\"
  162. .SH COPYRIGHT
  163. Portions of this text are reprinted and reproduced in electronic form
  164. from IEEE Std 1003.1-2017, Standard for Information Technology
  165. -- Portable Operating System Interface (POSIX), The Open Group Base
  166. Specifications Issue 7, 2018 Edition,
  167. Copyright (C) 2018 by the Institute of
  168. Electrical and Electronics Engineers, Inc and The Open Group.
  169. In the event of any discrepancy between this version and the original IEEE and
  170. The Open Group Standard, the original IEEE and The Open Group Standard
  171. is the referee document. The original Standard can be obtained online at
  172. http://www.opengroup.org/unix/online.html .
  173. .PP
  174. Any typographical or formatting errors that appear
  175. in this page are most likely
  176. to have been introduced during the conversion of the source files to
  177. man page format. To report such errors, see
  178. https://www.kernel.org/doc/man-pages/reporting_bugs.html .