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