release/man2/epoll_create.2

   1 .\"
   2 .\"  epoll by Davide Libenzi ( efficient event notification retrieval )
   3 .\"  Copyright (C) 2003  Davide Libenzi
   4 .\"
   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 License
  16 .\"  along with this program; if not, write to the Free Software
  17 .\"  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18 .\"
  19 .\"  Davide Libenzi <davidel@xmailserver.org>
  20 .\"
  21 .\" Modified 2004-06-17 by Michael Kerrisk <mtk.manpages@gmail.com>
  22 .\" Modified 2005-04-04 by Marko Kohtala <marko.kohtala@gmail.com>
  23 .\" 2008-10-10, mtk: add description of epoll_create1()
  24 .\"
  25 .\"*******************************************************************
  26 .\"
  27 .\" This file was generated with po4a. Translate the source file.
  28 .\"
  29 .\"*******************************************************************
  30 .TH EPOLL_CREATE 2 2012\-04\-15 Linux "Linux Programmer's Manual"
  31 .SH 名前
  32 epoll_create, epoll_create1 \- epoll ファイルディスクリプタをオープンする
  33 .SH 書式
  34 .nf
  35 \fB#include <sys/epoll.h>\fP
  36 .sp
  37 \fBint epoll_create(int \fP\fIsize\fP\fB);\fP
  38 \fBint epoll_create1(int \fP\fIflags\fP\fB);\fP
  39 .fi
  40 .SH 説明
  41 \fBepoll_create\fP()は \fBepoll\fP(7) インスタンスを作成する。
  42 Linux 2.6.8 以降では、\fIsize\fP 引き数は無視されるが、 0 より大きな値で
  43 なければならない。下記の「注意」を参照。
  44
  45 \fBepoll_create\fP()  は、新しい epoll インスタンスを参照するファイルディスクリプタを返す。
  46 このファイルディスクリプタは、その後の \fBepoll\fP インタフェースの呼び出しに使われる。 もう必要でなくなった場合は、
  47 \fBepoll_create\fP()  で返されたファイルディスクリプタは \fBclose\fP(2)  を使ってクローズされるべきである。 ある epoll
  48 インスタンスを参照する全てのファイルディスクリプタがクローズされると、 カーネルはそのインスタンスを破壊して、対応するリソースを解放し、
  49 再使用できるようにする。
  50
  51 .SS epoll_create1()
  52 \fBepoll_create1\fP()  は、 \fIflags\fP が 0 の場合、現在では使われていない \fIsize\fP 引き数がなくなっている点を除けば
  53 \fBepoll_create\fP()  と同じである。 \fIflags\fP に以下の値をビット毎の論理和 (OR) で指定することで、
  54 異なる動作をさせることができる。
  55 .TP
  56 \fBEPOLL_CLOEXEC\fP
  57 新しいファイルディスクリプタに対して close\-on\-exec (\fBFD_CLOEXEC\fP)  フラグをセットする。
  58 このフラグが役に立つ理由については、 \fBopen\fP(2)  の \fBO_CLOEXEC\fP フラグの説明を参照のこと。
  59 .SH 返り値
  60 成功すると、これらのシステムコールは 非負のファイルディスクリプタを返す。 エラーの場合、\-1 を返し、 \fIerrno\fP にエラーを示す値を設定する。
  61 .SH エラー
  62 .TP
  63 \fBEINVAL\fP
  64 \fIsize\fP が正でない。
  65 .TP
  66 \fBEINVAL\fP
  67 (\fBepoll_create1\fP())  \fIflags\fP に無効な値が指定された。
  68 .TP
  69 \fBEMFILE\fP
  70 \fI/proc/sys/fs/epoll/max_user_instances\fP によって指定されている、epoll
  71 インスタンスのユーザー単位の制限に達した。 更なる詳細については \fBepoll\fP(7)  を参照のこと。
  72 .TP
  73 \fBENFILE\fP
  74 オープンされたファイルの総数がシステム制限に達した。
  75 .TP
  76 \fBENOMEM\fP
  77 カーネルオブジェクトを作成するのに十分なメモリがなかった。
  78 .SH バージョン
  79 \fBepoll_create\fP() はカーネル 2.6 で追加された。
  80 ライブラリによるサポートは glibc バージョン 2.3.2 以降で提供されている。
  81
  82 .\" To be precise: kernel 2.5.44.
  83 .\" The interface should be finalized by Linux kernel 2.5.66.
  84 \fBepoll_create1\fP() はカーネル 2.6.27 で追加された。
  85 ライブラリによるサポートは glibc バージョン 2.9 以降で提供されている。
  86 .SH 準拠
  87 \fBepoll_create\fP() は Linux 独自である。
  88 .SH 注意
  89 初期の \fBepoll_create\fP() の実装では、\fIsize\fP 引き数は、呼び出し元が \fBepoll\fP
  90 インスタンスに追加しようとするファイルディスクリプタ数をカーネルに教えるのに
  91 使われていた。カーネルはこの情報をイベントの情報を格納する内部データ構造に最
  92 初に割り当てる大きさを決める際のヒントとして使用していた (\fIsize\fP で渡された
  93 ヒントよりも使用量が大きくなった場合には、必要に応じてカーネルは追加で領域を
  94 割り当てる)。
  95
  96 現在では、このヒントはもはや必要なくなっている (カーネルはヒントなしで必要な
  97 データ構造のサイズを動的に変更する) が、今も \fIsize\fP には 0 より大きい値を
  98 指定しなければならない。これは、\fBepoll\fP を使うアプリケーションが古いカーネル
  99 で実行される際の後方互換性を保証するためである。
 100 .SH 関連項目
 101 \fBclose\fP(2), \fBepoll_ctl\fP(2), \fBepoll_wait\fP(2), \fBepoll\fP(7)