release/man2/io_getevents.2

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