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_suspend.3p (4131B)

    

  1. '\" et
  2. .TH AIO_SUSPEND "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_suspend
  12. \(em wait for an asynchronous I/O request
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <aio.h>
  17. .P
  18. int aio_suspend(const struct aiocb *const \fIlist\fP[], int \fInent\fP,
  19.     const struct timespec *\fItimeout\fP);
  20. .fi
  21. .SH DESCRIPTION
  22. The
  23. \fIaio_suspend\fR()
  24. function shall suspend the calling thread until at least one of the
  25. asynchronous I/O operations referenced by the
  26. .IR list
  27. argument has completed, until a signal interrupts the function, or, if
  28. .IR timeout
  29. is not NULL, until the time interval specified by
  30. .IR timeout
  31. has passed. If any of the
  32. .BR aiocb
  33. structures in the list correspond to completed asynchronous I/O
  34. operations (that is, the error status for the operation is not equal to
  35. .BR [EINPROGRESS] )
  36. at the time of the call, the function shall return without suspending
  37. the calling thread. The
  38. .IR list
  39. argument is an array of pointers to asynchronous I/O control blocks.
  40. The
  41. .IR nent
  42. argument indicates the number of elements in the array. Each
  43. .BR aiocb
  44. structure pointed to has been used in initiating an asynchronous
  45. I/O request via
  46. \fIaio_read\fR(),
  47. \fIaio_write\fR(),
  48. or
  49. \fIlio_listio\fR().
  50. This array may contain null pointers, which are ignored. If this array
  51. contains pointers that refer to
  52. .BR aiocb
  53. structures that have not been used in submitting asynchronous I/O, the
  54. effect is undefined.
  55. .P
  56. If the time interval indicated in the
  57. .BR timespec
  58. structure pointed to by
  59. .IR timeout
  60. passes before any of the I/O operations referenced by
  61. .IR list
  62. are completed, then
  63. \fIaio_suspend\fR()
  64. shall return with an error.
  65. If the Monotonic Clock option is supported, the clock that shall be
  66. used to measure this time interval shall be the CLOCK_MONOTONIC clock.
  67. .SH "RETURN VALUE"
  68. If the
  69. \fIaio_suspend\fR()
  70. function returns after one or more asynchronous I/O operations have
  71. completed, the function shall return zero. Otherwise, the function shall
  72. return a value of \-1 and set
  73. .IR errno
  74. to indicate the error.
  75. .P
  76. The application may determine which asynchronous I/O completed by
  77. scanning the associated error and return status using
  78. \fIaio_error\fR()
  79. and
  80. \fIaio_return\fR(),
  81. respectively.
  82. .SH ERRORS
  83. The
  84. \fIaio_suspend\fR()
  85. function shall fail if:
  86. .TP
  87. .BR EAGAIN
  88. No asynchronous I/O indicated in the list referenced by
  89. .IR list
  90. completed in the time interval indicated by
  91. .IR timeout .
  92. .TP
  93. .BR EINTR
  94. A signal interrupted the
  95. \fIaio_suspend\fR()
  96. function. Note that, since each asynchronous I/O operation may
  97. possibly provoke a signal when it completes, this error return may be
  98. caused by the completion of one (or more) of the very I/O operations
  99. being awaited.
  100. .LP
  101. .IR "The following sections are informative."
  102. .SH EXAMPLES
  103. None.
  104. .SH "APPLICATION USAGE"
  105. None.
  106. .SH RATIONALE
  107. None.
  108. .SH "FUTURE DIRECTIONS"
  109. None.
  110. .SH "SEE ALSO"
  111. .IR "\fIaio_read\fR\^(\|)",
  112. .IR "\fIaio_write\fR\^(\|)",
  113. .IR "\fIlio_listio\fR\^(\|)"
  114. .P
  115. The Base Definitions volume of POSIX.1\(hy2017,
  116. .IR "\fB<aio.h>\fP"
  117. .\"
  118. .SH COPYRIGHT
  119. Portions of this text are reprinted and reproduced in electronic form
  120. from IEEE Std 1003.1-2017, Standard for Information Technology
  121. -- Portable Operating System Interface (POSIX), The Open Group Base
  122. Specifications Issue 7, 2018 Edition,
  123. Copyright (C) 2018 by the Institute of
  124. Electrical and Electronics Engineers, Inc and The Open Group.
  125. In the event of any discrepancy between this version and the original IEEE and
  126. The Open Group Standard, the original IEEE and The Open Group Standard
  127. is the referee document. The original Standard can be obtained online at
  128. http://www.opengroup.org/unix/online.html .
  129. .PP
  130. Any typographical or formatting errors that appear
  131. in this page are most likely
  132. to have been introduced during the conversion of the source files to
  133. man page format. To report such errors, see
  134. https://www.kernel.org/doc/man-pages/reporting_bugs.html .