epoll_wait, epoll_pwait − wait for an I/O event on an epoll file descriptor
epoll_wait(int epfd, struct epoll_event
int maxevents, int timeout);
int epoll_pwait(int epfd, struct epoll_event *events,
int maxevents, int timeout,
const sigset_t *sigmask);
The epoll_wait() system call waits for events on the epoll(7) instance referred to by the file descriptor epfd. The memory area pointed to by events will contain the events that will be available for the caller. Up to maxevents are returned by epoll_wait(). The maxevents argument must be greater than zero.
The timeout argument specifies the number of milliseconds that epoll_wait() will block. The call will block until either:
a file descriptor delivers an event;
the call is interrupted by a signal handler; or
the timeout expires.
Note that the timeout 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 timeout of −1 causes epoll_wait() to block indefinitely, while specifying a timeout equal to zero cause epoll_wait() to return immediately, even if no events are available.
The struct epoll_event is defined as :
uint32_t events; /* Epoll events */
epoll_data_t data; /* User data variable */
The data of each returned structure will contain the same data the user set with an epoll_ctl(2) (EPOLL_CTL_ADD, EPOLL_CTL_MOD) while the events member will contain the returned event bit field.
The relationship between epoll_wait() and epoll_pwait() is analogous to the relationship between select(2) and pselect(2): like pselect(2), epoll_pwait() allows an application to safely wait until either a file descriptor becomes ready or until a signal is caught.
The following epoll_pwait() call:
ready = epoll_pwait(epfd, &events, maxevents, timeout, &sigmask);
is equivalent to atomically executing the following calls:
ready = epoll_wait(epfd, &events, maxevents, timeout);
sigprocmask(SIG_SETMASK, &origmask, NULL);
The sigmask argument may be specified as NULL, in which case epoll_pwait() is equivalent to epoll_wait().
When successful, epoll_wait() returns the number of file descriptors ready for the requested I/O, or zero if no file descriptor became ready during the requested timeout milliseconds. When an error occurs, epoll_wait() returns −1 and errno is set appropriately.
epfd is not a valid file descriptor.
The memory area pointed to by events is not accessible with write permissions.
epfd is not an epoll file descriptor, or maxevents is less than or equal to zero.
epoll_wait() was added to the kernel in version 2.6. Library support is provided in glibc starting with version 2.3.2.
epoll_pwait() was added to Linux in kernel 2.6.19. Library support is provided in glibc starting with version 2.6.
epoll_wait() is Linux-specific.
While one thread is blocked in a call to epoll_pwait(), it is possible for another thread to add a file descriptor to the waited-upon epoll instance. If the new file descriptor becomes ready, it will cause the epoll_wait() call to unblock.
For a discussion of what may happen if a file descriptor in an epoll instance being monitored by epoll_wait() is closed in another thread, see select(2).
In kernels before 2.6.37, a timeout value larger than approximately LONG_MAX / HZ milliseconds is treated as −1 (i.e., infinity). Thus, for example, on a system where the sizeof(long) is 4 and the kernel HZ value is 1000, this means that timeouts greater than 35.79 minutes are treated as infinity.
This page is part of release 3.69 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at http://www.kernel.org/doc/man−pages/.
More Linux Commands
ldap_get_dn(3) - LDAP DN handling routines - Linux man page
These routines allow LDAP entry names (Distinguished Names, or DNs) to be obtained, parsed, converted to a user-friendly form, and tested. A DN has the form des
debugfs(8) - ext2/ext3/ext4 file system debugger (Man Page)
The debugfs program is an interactive file system debugger. It can be used to examine and change the state of an ext2, ext3, or ext4 file system. device is the
fcvt_r(3) - convert a floating-point number to a string.....
The functions ecvt_r(), fcvt_r(), qecvt_r() and qfcvt_r() are identical to ecvt(3), fcvt(3), qecvt(3) and qfcvt(3), respectively, except that they do not return
SDL_DisplayFormatAlpha(3) - Convert a surface to the display
This function takes a surface and copies it to a new surface of the pixel format and colors of the video framebuffer plus an alpha channel, suitable for fast bl
gnutls_priority_deinit(3) - API function - Linux man page...
Deinitializes the priority cache. REPORTING BUGS Report bugs to <email@example.com>. GnuTLS home page: http://www.gnu.org/software/gnutls/ General help using G
glutDeviceGet(3) - retrieves GLUT device information represe
glutDeviceGet retrieves GLUT device information represented by integers. The info parameter determines what type of device information to return. Requesting dev
grub2-menulst2cfg(1) transform legacy menu.lst into grub.cfg
SEE ALSO grub-mkconfig(8) The full documentation for grub-menulst2cfg is maintained as a Texinfo manual. If the info and grub-menulst2cfg programs are properly
tanf(3) - tangent function (Library - Linux man page).......
The tan() function returns the tangent of x, where x is given in radians. RETURN VALUE On success, these functions return the tangent of x. If x is a NaN, a NaN
ninpaths(8) - Report Usenet Path statistics (new inpaths)...
This is an efficient and space-saving inpaths reporting program. It works as follows: you feed it the Path lines via an INN channel feed or some other similar m
fchmodat(2) - change permissions of a file relative to a dir
The chmod() and fchmod() system calls change the permissions of a file. They differ only in how the file is specified: * chmod() changes the permissions of the
nstat(8) - network statistics tools. - Linux manual page....
nstat and rtacct are simple tools to monitor kernel snmp counters and network interface statistics. OPTIONS -h, --help Print help -V, --version Print version -z
acpidump(8) Dump systems ACPI tables to an ASCII file.......
acpidump dumps the systems ACPI tables to an ASCII file appropriate for attaching to a bug report. Subsequently, they can be processed by utilities in the ACPIC