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

poll.h.0p (3519B)

    

  1. '\" et
  2. .TH poll.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. poll.h
  12. \(em definitions for the poll(\|) function
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <poll.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <poll.h> 
  21. header shall define the
  22. .BR pollfd
  23. structure, which shall include at least the following members:
  24. .sp
  25. .RS 4
  26. .nf
  28. int    fd       \fRThe following descriptor being polled.\fP
  29. short  events   \fRThe input event flags (see below).\fP
  30. short  revents  \fRThe output event flags (see below).\fP
  31. .fi
  32. .P
  33. .RE
  34. .P
  35. The
  36. .IR <poll.h> 
  37. header shall define the following type through
  38. .BR typedef :
  39. .IP "\fBnfds_t\fR" 14
  40. An unsigned integer type used for the number of file descriptors.
  41. .P
  42. The implementation shall support one or more programming environments
  43. in which the width of
  44. .BR nfds_t
  45. is no greater than the width of type
  46. .BR long .
  47. The names of these programming environments can be obtained using the
  48. \fIconfstr\fR()
  49. function or the
  50. .IR getconf
  51. utility.
  52. .P
  53. The
  54. .IR <poll.h> 
  55. header shall define the following symbolic constants, zero or more of
  56. which may be OR'ed together to form the
  57. .IR events
  58. or
  59. .IR revents
  60. members in the
  61. .BR pollfd
  62. structure:
  63. .IP POLLIN 14
  64. Data other than high-priority data may be read without blocking.
  65. .IP POLLRDNORM 14
  66. Normal data may be read without blocking.
  67. .IP POLLRDBAND 14
  68. Priority data may be read without blocking.
  69. .IP POLLPRI 14
  70. High priority data may be read without blocking.
  71. .IP POLLOUT 14
  72. Normal data may be written without blocking.
  73. .IP POLLWRNORM 14
  74. Equivalent to POLLOUT.
  75. .IP POLLWRBAND 14
  76. Priority data may be written.
  77. .IP POLLERR 14
  78. An error has occurred (\c
  79. .IR revents
  80. only).
  81. .IP POLLHUP 14
  82. Device has been disconnected (\c
  83. .IR revents
  84. only).
  85. .IP POLLNVAL 14
  86. Invalid
  87. .IR fd
  88. member (\c
  89. .IR revents
  90. only).
  91. .P
  92. The significance and semantics of normal, priority, and high-priority
  93. data are file and device-specific.
  94. .P
  95. The following shall be declared as a function and may also be defined
  96. as a macro. A function prototype shall be provided.
  97. .sp
  98. .RS 4
  99. .nf
  101. int   poll(struct pollfd [], nfds_t, int);
  102. .fi
  103. .P
  104. .RE
  105. .LP
  106. .IR "The following sections are informative."
  107. .SH "APPLICATION USAGE"
  108. None.
  109. .SH RATIONALE
  110. None.
  111. .SH "FUTURE DIRECTIONS"
  112. None.
  113. .SH "SEE ALSO"
  114. The System Interfaces volume of POSIX.1\(hy2017,
  115. .IR "\fIconfstr\fR\^(\|)",
  116. .IR "\fIpoll\fR\^(\|)"
  117. .P
  118. The Shell and Utilities volume of POSIX.1\(hy2017,
  119. .IR "\fIgetconf\fR\^"
  120. .\"
  121. .SH COPYRIGHT
  122. Portions of this text are reprinted and reproduced in electronic form
  123. from IEEE Std 1003.1-2017, Standard for Information Technology
  124. -- Portable Operating System Interface (POSIX), The Open Group Base
  125. Specifications Issue 7, 2018 Edition,
  126. Copyright (C) 2018 by the Institute of
  127. Electrical and Electronics Engineers, Inc and The Open Group.
  128. In the event of any discrepancy between this version and the original IEEE and
  129. The Open Group Standard, the original IEEE and The Open Group Standard
  130. is the referee document. The original Standard can be obtained online at
  131. http://www.opengroup.org/unix/online.html .
  132. .PP
  133. Any typographical or formatting errors that appear
  134. in this page are most likely
  135. to have been introduced during the conversion of the source files to
  136. man page format. To report such errors, see
  137. https://www.kernel.org/doc/man-pages/reporting_bugs.html .