epoll_waitのヘルプ・マニュアル
日本語 英語
epoll_wait --help
man epoll_wait
EPOLL_WAIT(2) Linux Programmer’s Manual EPOLL_WAIT(2)
名前
epoll_wait, epoll_pwait - epoll ファイルディスクリプタの I/O イベントを
待つ
書式
#include
int epoll_wait(int epfd, struct epoll_event *events,
int maxevents, int timeout);
int epoll_pwait(int epfd, struct epoll_event *events,
int maxevents, int timeout,
const sigset_t *sigmask);
説明
epoll_wait() システムコールは、ファイルディスクリプタ epfd で参照される
epoll インスタンスに対するイベントを待つ。 events が指すメモリ領域には
、呼び出し側が利用可能なイベントが格納される。最大 maxevents 個のイベン
ト が epoll_wait() によって返される。 maxevents 引き数は 0 より大きくな
ければならない。
最大で timeout ミリ秒間イベントを待つ。 timeout を -1 に指定す る と 、
epoll_wait() は 無 限 に 待 つ 。 ま た timeout を 0 に指定すると、
epoll_wait() はイベントが利用可能でなくても、すぐに返る (返り値は 0 で
ある)。
struct epoll_event は以下のように定義される:
typedef union epoll_data {
void *ptr;
int fd;
uint32_t u32;
uint64_t u64;
} epoll_data_t;
struct epoll_event {
uint32_t events; /* epoll イベント */
epoll_data_t data; /* ユーザデータ変数 */
};
返される構造体の data メンバには、ユーザが epoll_ctl(2) (EPOLL_CTL_ADD,
EPOLL_CTL_MOD) で指定したデータが格納される。一方、 events メンバには返
された利用可能なイベントのビットフィールドが格納される。
epoll_pwait()
epoll_wait() と epoll_pwait() の関係は、 select(2) と pselect(2) の関係
と同様である。 pselect(2) 同様、 epoll_pwait() を使うと、アプリケーショ
ン は、ファイルディスクリプタが準備できた状態になるか、シグナルが捕捉さ
れるまで、安全に待つことができる。
以下の epoll_pwait() の呼び出しは、
ready = epoll_pwait(epfd, &events, maxevents, timeout, &sigmask);
次の呼び出しを atomic に実行するのと等価である。
sigset_t origmask;
sigprocmask(SIG_SETMASK, &sigmask, &origmask);
ready = epoll_wait(epfd, &events, maxevents, timeout);
sigprocmask(SIG_SETMASK, &origmask, NULL);
sigmask 引き数には NULL を指定してもよい。その場合には、 epoll_pwait()
は epoll_wait() と等価となる。
返り値
成功した場合、 epoll_wait() は要求された I/O に対して準備ができているフ
ァイルディスクリプタの数を返す。また要求された timeout ミリ秒の間にファ
イ ルディスクリプタが準備できない場合は、0 を返す。エラーが起こった場合
、 epoll_wait() は -1 を返し、 errno を適切に設定する。
エラー
EBADF epfd が有効なファイルディスクリプタでない。
EFAULT events で指されるメモリ領域に書き込み権限でアクセスできない。
EINTR 要求されたどのイベントも発生せず、かつ timeout の期限が切れる 前
に 、システムコールがシグナルハンドラによって割り込まれた。 sig-
nal(7) 参照。
EINVAL epfd が epoll ファイルディスクリプタでない。または maxevents が
0 以下である。
バージョン
epoll_pwait() はカーネル 2.6.19 で Linux に追加された。
epoll_pwait() の glibc でのサポートは glibc 2.6 以降で提供されている。
準拠
epoll_wait() は Linux 独自であり、カーネル 2.5.44 で導入された。
関連項目
epoll_create(2), epoll_ctl(2), epoll(7)
Linux 2009-01-17 EPOLL_WAIT(2)
EPOLL_WAIT(2) Linux Programmer’s Manual EPOLL_WAIT(2)
NAME
epoll_wait, epoll_pwait - wait for an I/O event on an epoll file
descriptor
SYNOPSIS
#include
int epoll_wait(int epfd, struct epoll_event *events,
int maxevents, int timeout);
int epoll_pwait(int epfd, struct epoll_event *events,
int maxevents, int timeout,
const sigset_t *sigmask);
DESCRIPTION
The epoll_wait() system call waits for events on the epoll 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 call waits for a maximum time of timeout milliseconds. Specifying
a timeout of -1 makes epoll_wait() wait indefinitely, while specifying
a timeout equal to zero makes epoll_wait() to return immediately even
if no events are available (return code equal to zero).
The struct epoll_event is defined as :
typedef union epoll_data {
void *ptr;
int fd;
uint32_t u32;
uint64_t u64;
} epoll_data_t;
struct epoll_event {
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.
epoll_pwait()
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:
sigset_t origmask;
sigprocmask(SIG_SETMASK, &sigmask, &origmask);
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().
RETURN VALUE
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.
ERRORS
EBADF epfd is not a valid file descriptor.
EFAULT The memory area pointed to by events is not accessible with
write permissions.
EINTR The call was interrupted by a signal handler before any of the
requested events occurred or the timeout expired; see signal(7).
EINVAL epfd is not an epoll file descriptor, or maxevents is less than
or equal to zero.
VERSIONS
epoll_pwait() was added to Linux in kernel 2.6.19.
Glibc support for epoll_pwait() is provided starting with version 2.6.
CONFORMING TO
epoll_wait() is Linux-specific, and was introduced in kernel 2.5.44.
SEE ALSO
epoll_create(2), epoll_ctl(2), epoll(7)
COLOPHON
This page is part of release 3.22 of the Linux man-pages project. A
description of the project, and information about reporting bugs, can
be found at http://www.kernel.org/doc/man-pages/.
Linux 2009-01-17 EPOLL_WAIT(2)