diff options
Diffstat (limited to 'usr/src/man/man3c/epoll_ctl.3c')
| -rw-r--r-- | usr/src/man/man3c/epoll_ctl.3c | 19 |
1 files changed, 14 insertions, 5 deletions
diff --git a/usr/src/man/man3c/epoll_ctl.3c b/usr/src/man/man3c/epoll_ctl.3c index ccf3139396..19c02f2abb 100644 --- a/usr/src/man/man3c/epoll_ctl.3c +++ b/usr/src/man/man3c/epoll_ctl.3c @@ -21,7 +21,6 @@ epoll_ctl \- control an epoll instance .fi .SH DESCRIPTION -.sp .LP The \fBepoll_ctl()\fR function executes the operation specified by \fIop\fR (as parameterized by \fIevent\fR) on the \fIepfd\fR epoll instance. @@ -93,6 +92,7 @@ of any combination of the following event flags: .ne 2 .na \fBEPOLLIN\fR +.ad .RS 14n Data other than high priority data may be read without blocking. For streams, this flag is set in the returned \fIevents\fR even if the message is of @@ -103,6 +103,7 @@ zero length. .ne 2 .na \fBEPOLLPRI\fR +.ad .RS 14n Normal data (priority band equals 0) may be read without blocking. For streams, this flag is set in the returned \fIevents\fR even if the message is of zero @@ -113,6 +114,7 @@ length. .ne 2 .na \fBEPOLLOUT\fR +.ad .RS 14n Normal data (priority band equals 0) may be written without blocking. .RE @@ -121,6 +123,7 @@ Normal data (priority band equals 0) may be written without blocking. .ne 2 .na \fBEPOLLRDNORM\fR +.ad .RS 14n Normal data (priority band equals 0) may be read without blocking. For streams, this flag is set in the returned \fIrevents\fR even if the message is of @@ -131,6 +134,7 @@ zero length. .ne 2 .na \fBEPOLLRDBAND\fR +.ad .RS 14n Data from a non-zero priority band may be read without blocking. For streams, this flag is set in the returned \fIrevents\fR even if the message is of @@ -141,6 +145,7 @@ zero length. .ne 2 .na \fBEPOLLWRNORM\fR +.ad .RS 14n The same as \fBEPOLLOUT\fR. .RE @@ -149,6 +154,7 @@ The same as \fBEPOLLOUT\fR. .ne 2 .na \fBEPOLLWRBAND\fR +.ad .RS 14n Priority data (priority band > 0) may be written. This event only examines bands that have been written to at least once. @@ -158,6 +164,7 @@ bands that have been written to at least once. .ne 2 .na \fBEPOLLMSG\fR +.ad .RS 14n This exists only for backwards binary and source compatibility with Linux; it has no meaning and is ignored. @@ -167,6 +174,7 @@ it has no meaning and is ignored. .ne 2 .na \fBEPOLLERR\fR +.ad .RS 14n An error has occurred on the device or stream. This flag is only valid in the returned \fIevents\fR field. @@ -176,6 +184,7 @@ returned \fIevents\fR field. .ne 2 .na \fBEPOLLHUP\fR +.ad .RS 14n A hangup has occurred on the stream. This event and \fBEPOLLOUT\fR are mutually exclusive; a stream can never be writable if a hangup has occurred. However, @@ -190,6 +199,7 @@ in the \fIevents\fR field specified via \fBepoll_ctl()\fR. .ne 2 .na \fBEPOLLRDHUP\fR +.ad .RS 14n The stream socket peer shutdown the writing half of the connection and no further data will be readable via the socket. This event is not mutually @@ -200,6 +210,7 @@ exclusive with \fBEPOLLIN\fR. .ne 2 .na \fBEPOLLWAKEUP\fR +.ad .RS 14n This exists only for backwards binary and source compatibility with Linux; it has no meaning and is ignored. @@ -209,6 +220,7 @@ it has no meaning and is ignored. .ne 2 .na \fBEPOLLONESHOT\fR +.ad .RS 14n Sets the specified event to be in one-shot mode, whereby the event association with the \fBepoll\fR(5) instance specified by \fIepfd\fR is removed atomically @@ -221,6 +233,7 @@ races inherent in multithreaded use of \fBepoll_wait\fR(3C). .ne 2 .na \fBEPOLLET\fR +.ad .RS 14n Sets the specified event to be edge-triggered mode instead of the default mode of level-triggered. In this mode, events will be induced by @@ -231,14 +244,12 @@ with caution. .RE .SH RETURN VALUES -.sp .LP Upon succesful completion, \fBepoll_ctl()\fR returns 0. If an error occurs, -1 is returned and errno is set to indicate the error. .SH ERRORS -.sp .LP \fBepoll_ctl()\fR will fail if: .sp @@ -283,7 +294,6 @@ specified \fBepoll\fR(5) instance. .sp .SH NOTES -.sp .LP The \fBepoll\fR(5) facility is implemented for purposes of offering @@ -293,7 +303,6 @@ applications should continue to prefer using event ports via the interfaces. See \fBepoll\fR(5) for compatibility details and restrictions. .SH SEE ALSO -.sp .LP \fBepoll_create\fR(3C), \fBepoll_wait\fR(3C), \fBport_create\fR(3C), \fBport_associate\fR(3C), \fBport_get\fR(3C), |