release/man2/io_getevents.2

   1 .\" Copyright (C) 2003 Free Software Foundation, Inc.
   2 .\"
   3 .\" %%%LICENSE_START(GPL_NOVERSION_ONELINE)
   4 .\" This file is distributed according to the GNU General Public License.
   5 .\" %%%LICENSE_END
   6 .\"
   7 .\"*******************************************************************
   8 .\"
   9 .\" This file was generated with po4a. Translate the source file.
  10 .\"
  11 .\"*******************************************************************
  12 .TH IO_GETEVENTS 2 2013\-04\-08 Linux "Linux Programmer's Manual"
  13 .SH 名前
  14 io_getevents \- 完了キューから非同期 I/O イベントを読み出す
  15 .SH 書式
  16 .nf
  17 \fB#include <linux/aio_abi.h>\fP         /* 必要な型の定義 */
  18 \fB#include <linux/time.h>\fP            /* 'struct timespec' の定義 */
  19
  20 \fBint io_getevents(aio_context_t \fP\fIctx_id\fP\fB, long \fP\fImin_nr\fP\fB, long \fP\fInr\fP\fB,\fP
  21 \fB                 struct io_event *\fP\fIevents\fP\fB, struct timespec *\fP\fItimeout\fP\fB);\fP
  22 .fi
  23
  24 \fI注\fP: このシステムコールには glibc のラッパー関数は存在しない。「注意」の節を参照。
  25 .SH 説明
  26 .PP
  27 \fBio_getevents\fP() システムコールは、少なくとも \fImin_nr\fP の、最大
  28 \fInr\fP 個のイベントを、 \fIctx_id\fP 引き数で指定された AIO (非同期 I/O)
  29 コンテキストの 完了キューから読み出そうとする。 \fItimeout\fP はイベント
  30 読み出しの待ち時間の合計を指定する。 タイムアウトに NULL を指定した場合、
  31 少なくとも \fImin_nr\fP 個のイベントが 読み出されるまで待つことを意味する。
  32 注意点を以下にあげる: \fItimeout\fP は相対的な指定である。
  33 .SH 返り値
  34 成功すると、 \fBio_getevents\fP()  は読み出したイベント数を返す。 イベントが一つも読み出されなかった場合は 0 が返され、
  35 \fItimeout\fP 時間が経過した場合は \fImin_nr\fP 未満の値が返される。 失敗時の返り値については、「注意」の節を参照すること。
  36 .SH エラー
  37 .TP
  38 \fBEFAULT\fP
  39 \fIevents\fP または \fItimeout\fP が無効なポインタである。
  40 .TP
  41 \fBEINVAL\fP
  42 \fIctx_id\fP が無効である。もしくは、\fImin_nr\fP または \fInr\fP が 範囲外の値である。
  43 .TP
  44 \fBEINTR\fP
  45 シグナルハンドラにより割り込まれた。 \fBsignal\fP(7)  参照。
  46 .TP
  47 \fBENOSYS\fP
  48 \fBio_getevents\fP()  がこのアーキテクチャでは実装されていない。
  49 .SH バージョン
  50 .PP
  51 非同期 I/O システム・コールは Linux 2.5 で初めて登場した。
  52 .SH 準拠
  53 .PP
  54 \fBio_getevents\fP()  は Linux 固有であり、移植を想定したプログラムで 使用すべきではない。
  55 .SH 注意
  56 .\" http://git.fedorahosted.org/git/?p=libaio.git
  57 glibc はこのシステムコールのラッパー関数を提供していない。
  58 \fBsyscall\fP(2) を使ってこのシステムコールを起動することができる。
  59 しかし、たいていは、このシステムコールを呼び出したいのではなく、
  60  \fIlibaio\fP が提供している \fBio_getevents\fP ラッパー関数を呼び出したい
  61 場合がほとんどであろう。
  62
  63 .\" But glibc is confused, since <libaio.h> uses 'io_context_t' to declare
  64 .\" the system call.
  65 \fIlibaio\fP のラッパー関数では \fIctx_id\fP 引き数に別の型
  66 (\fIio_context_t\fP) が使われることに注意すること。
  67 また、\fIlibaio\fP のラッパー関数は、エラーの通知が通常の C ライブラリの
  68 慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列
  69 挙されている値の一つを負にしたもの) が返り値となる点にも注意すること。
  70 \fBsyscall\fP(2) 経由でシステムコールを起動すると、返り値は通常のエラー通
  71 知の慣習に したがってものとなり、エラーの場合には \-1 が返り、 \fIerrno\fP
  72 にエラーを示す (正の) 値が設定される。
  73 .SH バグ
  74 無効な \fIctx_id\fP を指定した場合、エラー \fBEINVAL\fP が生成されず、セグメンテーション違反 (segmentation fault)
  75 が発生する場合がある。
  76 .SH 関連項目
  77 .PP
  78 .\" .SH AUTHOR
  79 .\" Kent Yoder.
  80 \fBio_cancel\fP(2), \fBio_destroy\fP(2), \fBio_setup\fP(2), \fBio_submit\fP(2),
  81 \fBaio\fP(7), \fBtime\fP(7)
  82 .SH この文書について
  83 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.51 の一部
  84 である。プロジェクトの説明とバグ報告に関する情報は
  85 http://www.kernel.org/doc/man\-pages/ に書かれている。