+++ /dev/null
-.\" Copyright (C) 1997 Andries Brouwer (aeb@cwi.nl)
-.\" and Copyright (C) 2006, Michael Kerrisk <mtk.manpages@gmail.com>
-.\"
-.\" %%%LICENSE_START(VERBATIM)
-.\" Permission is granted to make and distribute verbatim copies of this
-.\" manual provided the copyright notice and this permission notice are
-.\" preserved on all copies.
-.\"
-.\" Permission is granted to copy and distribute modified versions of this
-.\" manual under the conditions for verbatim copying, provided that the
-.\" entire resulting derived work is distributed under the terms of a
-.\" permission notice identical to this one.
-.\"
-.\" Since the Linux kernel and libraries are constantly changing, this
-.\" manual page may be incorrect or out-of-date. The author(s) assume no
-.\" responsibility for errors or omissions, or for damages resulting from
-.\" the use of the information contained herein. The author(s) may not
-.\" have taken the same level of care in the production of this manual,
-.\" which is licensed free of charge, as they might when working
-.\" professionally.
-.\"
-.\" Formatted or processed versions of this manual, if unaccompanied by
-.\" the source, must acknowledge the copyright and authors of this work.
-.\" %%%LICENSE_END
-.\"
-.\" Additions from Richard Gooch <rgooch@atnf.CSIRO.AU> and aeb, 971207
-.\" 2006-03-13, mtk, Added ppoll() + various other rewordings
-.\" 2006-07-01, mtk, Added POLLRDHUP + various other wording and
-.\" formatting changes.
-.\"
-.\"*******************************************************************
-.\"
-.\" This file was generated with po4a. Translate the source file.
-.\"
-.\"*******************************************************************
-.\"
-.\" Japanese Version Copyright (c) 1997 HANATAKA Shinya
-.\" all rights reserved.
-.\" Translated 1997-12-11, HANATAKA Shinya <hanataka@abyss.rim.or.jp>
-.\" Updated & Modified 2004-05-22, Yuichi SATO <ysato444@yahoo.co.jp>
-.\" Updated & Modified 2005-01-03, Yuichi SATO
-.\" Updated & Modified 2005-10-10, Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
-.\" Updated 2005-12-05, Akihiro MOTOKI, Catch up to LDP man-pages 2.16
-.\" Updated 2006-04-16, Akihiro MOTOKI, Catch up to LDP man-pages 2.28
-.\" Updated 2006-07-23, Akihiro MOTOKI, Catch up to LDP man-pages 2.36
-.\" Updated 2012-04-30, Akihiro MOTOKI <amotoki@gmail.com>
-.\" Updated 2012-05-29, Akihiro MOTOKI <amotoki@gmail.com>
-.\" Updated 2013-03-26, Akihiro MOTOKI <amotoki@gmail.com>
-.\"
-.TH POLL 2 2014\-09\-06 Linux "Linux Programmer's Manual"
-.SH 名前
-poll, ppoll \- ファイルディスクリプターにおけるイベントを待つ
-.SH 書式
-.nf
-\fB#include <poll.h>\fP
-.sp
-\fBint poll(struct pollfd *\fP\fIfds\fP\fB, nfds_t \fP\fInfds\fP\fB, int \fP\fItimeout\fP\fB);\fP
-.sp
-\fB#define _GNU_SOURCE\fP /* feature_test_macros(7) 参照 */
-\fB#include <signal.h>\fP
-\fB#include <poll.h>\fP
-.sp
-\fBint ppoll(struct pollfd *\fP\fIfds\fP\fB, nfds_t \fP\fInfds\fP\fB, \fP
-\fB const struct timespec *\fP\fItimeout_ts\fP\fB, const sigset_t *\fP\fIsigmask\fP\fB);\fP
-.fi
-.SH 説明
-\fBpoll\fP() は \fBselect\fP(2) と同様の仕事を行う、つまり、ファイルディスクリプター集合のいずれか一つが I/O
-を実行可能な状態になるのを待つ。
-
-監視するファイルディスクリプター集合は、 \fIfds\fP 引き数で指定する。 \fIfds\fP は、以下の型の構造体の配列である。
-.in +4n
-.nf
-
-struct pollfd {
- int fd; /* file descriptor */
- short events; /* requested events */
- short revents; /* returned events */
-};
-.in
-.fi
-.PP
-\fInfds\fP には、 \fIfds\fP 配列の要素数を指定する。
-
-\fIfd\fP フィールドには、オープンされたファイルのファイルディスクリプターが入る。 このフィールドが負の場合、対応する \fIevents\fP
-フィールドは無視され、 \fIrevents\fP には 0 が返される。(この機能により、一つの \fBpoll\fP()
-の呼び出しで簡単にあるファイルディスクリプターを無視することができる。 単に \fIfd\fP フィールドの符号を反転するだけでよい。
-ただし、この方法はファイルディスクリプター 0 を無視するのには使用できない点に注意すること。)
-
-構造体の \fIevents\fP 要素は入力パラメーターで、 ファイルディスクリプター \fIfd\fP に関して、
-アプリケーションが興味を持っているイベントのビットマスクを指定する。 このフィールドには 0 を指定することもでき、 その場合 \fIrevents\fP
-で返されるイベントは \fBPOLLHUP\fP, \fBPOLLERR\fP, \fBPOLLNVAL\fP だけである (下記参照)。
-
-\fIrevents\fP 要素は出力パラメーターで、実際に起こったイベントがカーネルにより設定される。 \fIrevents\fP で返されるビット列には、
-\fIevents\fP で指定したもののどれか、もしくは \fBPOLLERR\fP, \fBPOLLHUP\fP, \fBPOLLNVAL\fP のうちの一つが含まれる
-(\fBPOLLERR\fP, \fBPOLLHUP\fP, \fBPOLLNVAL\fP の 3つのビットは \fIevents\fP
-に指定しても意味がなく、対応した状態が真の場合に \fIrevents\fP に設定される)。
-
-どのファイルディスクリプターにも要求したイベントが発生しておらず、 エラーも起こらない場合、 \fBpoll\fP()
-はイベントのうちいずれか一つが発生するまで停止 (block) する。
-
-\fItimeout\fP 引き数は、 ファイルディスクリプターが利用可能になるまで \fBpoll\fP() が停止する時間をミリ秒で指定する。
-\fBpoll\fP() の呼び出しは以下のいずれかになるまで停止する。
-.IP * 3
-ファイルディスクリプターが利用可能になる
-.IP *
-呼び出しがシグナルハンドラーにより割り込まれた
-.IP *
-タイムアウトが満了する
-.PP
-\fItimeout\fP 時間はシステムクロックの粒度に切り上げられ、 カーネルのスケジューリング遅延により少しだけ長くなる可能性がある点に注意すること。
-\fItimeout\fP に負の値を指定した場合、タイムアウト時間が無限大を意味する。 \fItimeout\fP を 0 に指定した場合、I/O
-可能なファイルディスクリプターがない場合であっても、 \fBpoll\fP() はすぐに返る。
-
-\fIevents\fP に指定したり、 \fIrevents\fP で返されるビットは \fI<poll.h>\fP で定義されている:
-.RS
-.TP
-\fBPOLLIN\fP
-読み出し可能なデータがある。
-.TP
-\fBPOLLPRI\fP
-読み出し可能な緊急データ (urgent data) がある (例えば、TCP ソケットの帯域外 (out\-of\-band data)
-データを受信した場合や、 パケットモードの擬似端末のマスタがスレーブ側の変化を見つけたとき)。
-.TP
-\fBPOLLOUT\fP
-書き込みが可能になった。ただし、ソケットやパイプで利用可能な空間よりも大きなデータを書き込んだ場合には (\fBO_NONBLOCK\fP
-がセットされている場合以外は) やはり停止することになる。
-.TP
-\fBPOLLRDHUP\fP (Linux 2.6.17 以降)
-ストリームソケットの他端が、コネクションを close したか、 コネクションの書き込み側を shutdown した。 この定義を有効にするには、
-(「どの」ヘッダーファイルをインクルードするよりも前に) \fB_GNU_SOURCE\fP 機能検査マクロを定義しなければならない。
-.TP
-\fBPOLLERR\fP
-エラー状態 (出力の場合のみ)。
-.TP
-\fBPOLLHUP\fP
-ハングアップした (出力の場合のみ)。
-.TP
-\fBPOLLNVAL\fP
-不正な要求: \fIfd\fP がオープンされていない (出力の場合のみ)。
-.RE
-.PP
-\fB_XOPEN_SOURCE\fP を定義してコンパイルした場合には、以下の定義も行われる。
-ただし、上記のリストにあるビット以上の情報が得られる訳ではない。
-.RS
-.TP
-\fBPOLLRDNORM\fP
-\fBPOLLIN\fP と同じ。
-.TP
-\fBPOLLRDBAND\fP
-.\" POLLRDBAND is used in the DECnet protocol.
-優先帯域データ (priority band data) が読み出し可能である (普通は Linux では使用されない)。
-.TP
-\fBPOLLWRNORM\fP
-\fBPOLLOUT\fP と同じ。
-.TP
-\fBPOLLWRBAND\fP
-優先帯域データ (priority data) が書き込み可能である。
-.RE
-.PP
-Linux では \fBPOLLMSG\fP も定義されているが、使用されていない。
-.SS ppoll()
-\fBpoll\fP() と \fBppoll\fP() の関係は \fBselect\fP(2) と \fBpselect\fP(2) の関係と同じようなものである:
-\fBpselect\fP(2) と同様に、 \fBppoll\fP() を使うと、アプリケーションはファイルディスクリプターの状態変化
-もしくはシグナルの捕捉を安全に待つことができる。
-.PP
-\fItimeout\fP 引き数の精度の違いを除くと、以下の \fBppoll\fP() の呼び出しは、
-.nf
-
- ready = ppoll(&fds, nfds, timeout_ts, &sigmask);
-
-.fi
-次の呼び出しを \fIatomic\fP に実行するのと等価である。
-.nf
-
- sigset_t origmask;
- int timeout;
-
- timeout = (timeout_ts == NULL) ? \-1 :
- (timeout_ts.tv_sec * 1000 + timeout_ts.tv_nsec / 1000000);
- sigprocmask(SIG_SETMASK, &sigmask, &origmask);
- ready = poll(&fds, nfds, timeout);
- sigprocmask(SIG_SETMASK, &origmask, NULL);
-.fi
-.PP
-なぜ \fBppoll\fP() が必要なのかについての説明は \fBpselect\fP(2) の説明を参照のこと。
-
-\fIsigmask\fP 引き数に NULL が指定された場合、シグナルマスクの操作は行われない (したがって、 \fBppoll\fP() の
-\fBpoll\fP() との違いは \fItimeout\fP 引き数の精度だけとなる)。
-
-\fItimeout\fP 引き数は \fBppoll\fP() が停止する時間の上限を指定するものである。
-この引き数には以下の型の構造体へのポインターを指定する。
-.in +4n
-.nf
-
-struct timespec {
- long tv_sec; /* seconds */
- long tv_nsec; /* nanoseconds */
-};
-.fi
-.in
-
-\fItimeout_ts\fP に NULL が指定された場合、 \fBppoll\fP は無限に停止することがあり得る。
-.SH 返り値
-成功した場合は正の数を返す。この数は 0 以外の \fIrevents\fP 要素を持つ構造体の数である (別の言い方をすると、これらのディスクリプター
-にはイベントかエラー報告がある)。 値 0 は、タイムアウトとなり、どのファイルディスクリプターでもイベントが 発生しなかったことを示す。エラーの場合は
-\-1 が返され、 \fIerrno\fP が適切に設定される。
-.SH エラー
-.TP
-\fBEFAULT\fP
-引き数として指定した配列が、呼び出したプロセスのアドレス空間に 含まれていない。
-.TP
-\fBEINTR\fP
-要求されたイベントのどれかが起こる前にシグナルが発生した。 \fBsignal\fP(7) 参照。
-.TP
-\fBEINVAL\fP
-\fInfds\fP の値が \fBRLIMIT_NOFILE\fP を超えた。
-.TP
-\fBENOMEM\fP
-ファイルディスクリプターテーブルを確保するためのメモリーがない。
-.SH バージョン
-.\" library call was introduced in libc 5.4.28
-\fBpoll\fP() システムコールは Linux 2.1.23 で導入された。
-このシステムコールが存在しない古いカーネルでは、
-glibc (や古い Linux libc) は \fBselect\fP(2) を使用して \fBpoll\fP()
-ラッパー関数のエミュレーションを行う。
-
-\fBppoll\fP() システムコールは カーネル 2.6.16 で Linux に追加された。 \fBppoll\fP() ライブラリコールは glibc
-2.4 に追加された。
-.SH 準拠
-.\" NetBSD 3.0 has a pollts() which is like Linux ppoll().
-\fBpoll\fP() は POSIX.1\-2001 に準拠している。 \fBppoll\fP() は Linux 固有である。
-.SH 注意
-いくつかの実装では、値 \-1 を持った非標準の定数 \fBINFTIM\fP が定義されており、 \fBpoll\fP() の \fItimeout\fP
-の指定に使用できる。 この定数は glibc では定義されていない。
-
-\fBpoll\fP() で監視中のファイルディスクリプターが別のスレッドによってクローズされた場合に何が起こるかの議論については、 \fBselect\fP(2)
-を参照してほしい。
-.SS "C ライブラリとカーネル ABI の違い"
-Linux の \fBppoll\fP() システムコールは \fItimeout_ts\fP 引き数を変更する。 しかし、glibc
-のラッパー関数は、システムコールに渡す timeout 引き数 としてローカル変数を使うことでこの動作を隠蔽している。 このため、glibc の
-\fBppoll\fP() 関数では \fItimeout_ts\fP 引き数は変更されない。
-
-素の \fBppoll\fP() システムコールは 5 番目の引き数 \fIsize_t sigsetsize\fP をとる。 この引き数は \fIsigmask\fP
-引き数のバイト単位のサイズを指定する。 glibc の \fBppoll\fP() ラッパー関数は、この引き数に固定値
-(\fIsizeof(sigset_t)\fP と同じ) を指定する。
-.SH バグ
-\fBselect\fP(2) の「バグ」の節に書かれている、誤った準備完了通知 (spurious readiness notifications)
-についての議論を参照のこと。
-.SH 関連項目
-\fBrestart_syscall\fP(2), \fBselect\fP(2), \fBselect_tut\fP(2), \fBtime\fP(7)
-.SH この文書について
-この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.79 の一部
-である。プロジェクトの説明とバグ報告に関する情報は
-http://www.kernel.org/doc/man\-pages/ に書かれている。
OSDN Git Service
