epoll_wait.2: Clarify that 'timeout' is a *minimum* interval

Make it clear that 'timeout' is a minimum interval; the actual
interval will be rounded up to the system clock granularity,
and may overrun because of kernel scheduling delays.

Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
This commit is contained in:
Michael Kerrisk 2012-05-02 07:56:20 +12:00
parent 8c121f4004
commit f07cd91a9e
1 changed files with 8 additions and 3 deletions

View File

@ -20,7 +20,7 @@
.\"
.\" 2007-04-30: mtk, Added description of epoll_pwait()
.\"
.TH EPOLL_WAIT 2 2012-04-17 "Linux" "Linux Programmer's Manual"
.TH EPOLL_WAIT 2 2012-05-02 "Linux" "Linux Programmer's Manual"
.SH NAME
epoll_wait, epoll_pwait \- wait for an I/O event on an epoll file descriptor
.SH SYNOPSIS
@ -51,9 +51,14 @@ The
.I maxevents
argument must be greater than zero.
The call blocks the calling thread for a maximum time of
The
.I timeout
milliseconds.
argument specifies the minimum number of milliseconds that
.BR epoll_wait ()
will block.
(This interval will be rounded up to the system clock granularity,
and kernel scheduling delays mean that the blocking interval
may overrun by a small amount.)
Specifying a
.I timeout
of \-1 causes