draft/man2/epoll_ctl.2

   1 .\"  Copyright (C) 2003  Davide Libenzi
   2 .\"  Davide Libenzi <davidel@xmailserver.org>
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2+_SW_3_PARA)
   5 .\"  This program is free software; you can redistribute it and/or modify
   6 .\"  it under the terms of the GNU General Public License as published by
   7 .\"  the Free Software Foundation; either version 2 of the License, or
   8 .\"  (at your option) any later version.
   9 .\"
  10 .\"  This program is distributed in the hope that it will be useful,
  11 .\"  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\"  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\"  GNU General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public
  16 .\" License along with this manual; if not, see
  17 .\" <http://www.gnu.org/licenses/>.
  18 .\" %%%LICENSE_END
  19 .\"
  20 .\"*******************************************************************
  21 .\"
  22 .\" This file was generated with po4a. Translate the source file.
  23 .\"
  24 .\"*******************************************************************
  25 .TH EPOLL_CTL 2 2012\-04\-15 Linux "Linux Programmer's Manual"
  26 .SH 名前
  27 epoll_ctl \- epoll ディスクリプタのインタフェースを操作する
  28 .SH 書式
  29 \fB#include <sys/epoll.h>\fP
  30 .sp
  31 \fBint epoll_ctl(int \fP\fIepfd\fP\fB, int \fP\fIop\fP\fB, int \fP\fIfd\fP\fB, struct
  32 epoll_event *\fP\fIevent\fP\fB);\fP
  33 .SH 説明
  34 このシステムコールは、ファイルディスクリプタ \fIepfd\fP が参照する \fBepoll\fP(7)
  35 インスタンスに対する操作を行う。 対象のファイルディスクリプタ \fIfd\fP に対して、
  36 操作 \fIop\fP の実行が要求される。
  37
  38 \fIop\fP 引き数に指定できる有効な値は以下の通りである。
  39 .TP
  40 \fBEPOLL_CTL_ADD\fP
  41 対象のファイルディスクリプタ \fIfd\fP をファイルディスクリプタ \fIepfd\fP が参照する \fBepoll\fP インスタンスに登録し、イベント
  42 \fIevent\fP を \fIfd\fP に結び付けられた内部ファイルに関連付ける。
  43 .TP
  44 \fBEPOLL_CTL_MOD\fP
  45 イベント \fIevent\fP を対象のファイルディスクリプタ \fIfd\fP に関連付けるように変更する。
  46 .TP
  47 \fBEPOLL_CTL_DEL\fP
  48 対象のファイルディスクリプタ \fIfd\fP を \fIepfd\fP が参照する \fBepoll\fP インスタンスから削除する。 \fIevent\fP
  49 引き数は無視されるので、NULL にすることもできる (但し、下記の「バグ」を参照)。
  50 .PP
  51 \fIevent\fP 引き数は、ファイルディスクリプタ \fIfd\fP にリンクされたオブジェクトを表す。 \fIstruct epoll_event\fP
  52 は以下のように定義される:
  53 .sp
  54 .in +4n
  55 .nf
  56 typedef union epoll_data {
  57     void        *ptr;
  58     int          fd;
  59     uint32_t     u32;
  60     uint64_t     u64;
  61 } epoll_data_t;
  62
  63 struct epoll_event {
  64     uint32_t     events;      /* epoll イベント */
  65     epoll_data_t data;        /* ユーザデータ変数 */
  66 };
  67 .fi
  68 .in
  69
  70 \fIevents\fP メンバは、以下のような使用可能なイベントタイプを使って構成された ビットセットである。
  71 .TP
  72 \fBEPOLLIN\fP
  73 関連付けられたファイルに対して、 \fBread\fP(2)  操作が可能である。
  74 .TP
  75 \fBEPOLLOUT\fP
  76 関連付けられたファイルに対して、 \fBwrite\fP(2)  操作が可能である。
  77 .TP
  78 \fBEPOLLRDHUP"\fP(Linux\fB2.6.17\fP以降)"
  79 ストリームソケットの他端が、コネクションの close 、 またはコネクションの書き込み側の shutdown を行った。
  80 (このフラグを使うと、エッジトリガの監視を行う場合に、 通信のもう一端が閉じられたことを検知するコードを 非常に簡潔に書くことができる。)
  81 .TP
  82 \fBEPOLLPRI\fP
  83 \fBread\fP(2)  操作が可能な緊急 (urgent) データがある。
  84 .TP
  85 \fBEPOLLERR\fP
  86 関連付けられたファイルディスクリプタにエラー条件が起こった。 \fBepoll_wait\fP(2)  は常にこのイベントを待つので、 \fIevents\fP
  87 に設定する必要はない。
  88 .TP
  89 \fBEPOLLHUP\fP
  90 関連付けられたファイルディスクリプタにハングアップが起こった。 \fBepoll_wait\fP(2)  は常にこのイベントを待つので、 \fIevents\fP
  91 に設定する必要はない。
  92 .TP
  93 \fBEPOLLET\fP
  94 関連付けられたファイルディスクリプタに エッジトリガ動作 (Edge Triggered behavior) を設定する。 \fBepoll\fP
  95 のデフォルトの動作は、レベルトリガ (Level Triggered) である。 エッジトリガとレベルトリガによるイベント分配機構 (event
  96 distribution architectures) についての詳細な情報は、 \fBepoll\fP(7)  を参照すること。
  97 .TP
  98 \fBEPOLLONESHOT\fP (Linux 2.6.2 以降)
  99 関連付けられたファイルディスクリプタに 一撃動作 (One\-Shot behavior) を設定する。 これはイベントが
 100 \fBepoll_wait\fP(2)  によって引き出された後、 関連付けられたファイルディスクリプタが内部的に破棄され、 \fBepoll\fP
 101 インタフェースによってイベントが報告されなくなることを意味する。 新しいイベントマスクでファイルディスクリプタを再度有効にするためには、
 102 \fBepoll_ctl\fP()  に \fBEPOLL_CTL_MOD\fP を指定して呼び出さなければならない。 \fIop\fP
 103 引き数に指定できる有効な値は、以下の通り:
 104 .SH 返り値
 105 成功した場合、 \fBepoll_ctl\fP()  は 0 を返す。 エラーが起こった場合、 \fBepoll_ctl\fP()  は \-1 を返し、
 106 \fIerrno\fP を適切に設定する。
 107 .SH エラー
 108 .TP
 109 \fBEBADF\fP
 110 \fIepfd\fP か \fIfd\fP が有効なファイルディスクリプタでない。
 111 .TP
 112 \fBEEXIST\fP
 113 \fIop\fP が \fBEPOLL_CTL_ADD\fP であり、かつ与えられたファイルディスクリプタ \fIfd\fP がこの epoll
 114 インスタンスに既に登録されている。
 115 .TP
 116 \fBEINVAL\fP
 117 \fIepfd\fP が \fBepoll\fP ファイルディスクリプタでない。 または \fIfd\fP が \fIepfd\fP と同一である。 または要求された操作
 118 \fIop\fP がこのインタフェースでサポートされていない。
 119 .TP
 120 \fBENOENT\fP
 121 \fIop\fP が \fBEPOLL_CTL_MOD\fP または \fBEPOLL_CTL_DEL\fP で、かつ \fIfd\fP がこの epoll
 122 インスタンスに登録されていない。
 123 .TP
 124 \fBENOMEM\fP
 125 要求された \fIop\fP 制御操作を扱うのに十分なメモリがない。
 126 .TP
 127 \fBENOSPC\fP
 128 epoll インスタンスに新しいファイルディスクリプタを登録 (\fBEPOLL_CTL_ADD\fP)  しようとした際に、
 129 \fI/proc/sys/fs/epoll/max_user_watches\fP で決まる上限に達した。 詳細は \fBepoll\fP(7)  を参照。
 130 .TP
 131 \fBEPERM\fP
 132 対象ファイル \fIfd\fP が \fBepoll\fP をサポートしていない。
 133 .SH バージョン
 134 .\" To be precise: kernel 2.5.44.
 135 .\" The interface should be finalized by Linux kernel 2.5.66.
 136 \fBepoll_ctl\fP()  はカーネル 2.6 で追加された。
 137 .SH 準拠
 138 \fBepoll_ctl\fP()  は Linux 独自である。
 139 ライブラリによるサポートは glibc バージョン 2.3.2 以降で提供されている。
 140 .SH 注意
 141 \fBepoll\fP インタフェースは、 \fBpoll\fP(2)  に対応している全てのファイルディスクリプタに対応している。
 142 .SH バグ
 143 Linux 2.6.9 より前では、 \fBEPOLL_CTL_DEL\fP 操作の際、引き数 \fIevent\fP に (たとえ無視される場合であっても)
 144 NULL でないポインタを渡す必要があった。 カーネル 2.6.9 以降では、 \fBEPOLL_CTL_DEL\fP を使う際に \fIevent\fP に
 145 NULL を指定できるようになっている。 2.6.9 より前のカーネルへの移植性が必要なアプリケーションでは、 \fIevent\fP に NULL
 146 でないポインタを指定すべきである。
 147 .SH 関連項目
 148 \fBepoll_create\fP(2), \fBepoll_wait\fP(2), \fBpoll\fP(2), \fBepoll\fP(7)
 149 .SH この文書について
 150 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.53 の一部
 151 である。プロジェクトの説明とバグ報告に関する情報は
 152 http://www.kernel.org/doc/man\-pages/ に書かれている。