release/man2/io_cancel.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_CANCEL 2 2013\-04\-10 Linux "Linux Programmer's Manual"
  20 .SH 名前
  21 io_cancel \- 未処理の非同期 I/O 操作の取り消し
  22 .SH 書式
  23 .nf
  24 \fB#include <linux/aio_abi.h>\fP          /* 必要な型の定義 */
  25
  26 \fBint io_cancel(aio_context_t \fP\fIctx_id\fP\fB, struct iocb *\fP\fIiocb\fP\fB,\fP
  27 \fB              struct io_event *\fP\fIresult\fP\fB);\fP
  28 .fi
  29
  30 \fI注\fP: このシステムコールには glibc のラッパー関数は存在しない。「注意」の節を参照。
  31 .SH 説明
  32 .PP
  33 \fBio_cancel\fP() システムコールは、過去に \fBio_submit\fP(2) を使って登録された非同期 I/O (AIO)
  34 操作の取り消しを行おうとする。 \fIiocb\fP 引き数は取り消したい操作が示し、 \fIctx_id\fP 引き数は、取り消しを行う操作が登録された AIO
  35 コンテキストである。操作の取り消しに成功すると、対象のイベントは \fIresult\fP で指されたメモリに コピーされる
  36 (このとき、完了キューへの移動は行われない)。
  37 .SH 返り値
  38 成功した場合、 \fBio_cancel\fP()  は 0 を返す。 失敗時の返り値については、「注意」の節を参照すること。
  39 .SH エラー
  40 .TP
  41 \fBEAGAIN\fP
  42 指定された \fIiocb\fP の取り消しが行われなかった。
  43 .TP
  44 \fBEFAULT\fP
  45 データ構造の中に無効なデータを指しているものがある。
  46 .TP
  47 \fBEINVAL\fP
  48 \fIctx_id\fP で指定された AIO コンテキストが無効である。
  49 .TP
  50 \fBENOSYS\fP
  51 \fBio_cancel\fP()  はこのアーキテクチャでは実装されていない。
  52 .SH バージョン
  53 .PP
  54 非同期 I/O システム・コールは Linux 2.5 で初めて登場した。
  55 .SH 準拠
  56 .PP
  57 \fBio_cancel\fP()  は Linux 固有であり、移植を想定したプログラムで使用すべきではない。
  58 .SH 注意
  59 .\" http://git.fedorahosted.org/git/?p=libaio.git
  60 glibc はこのシステムコールのラッパー関数を提供していない。
  61 \fBsyscall\fP(2) を使ってこのシステムコールを起動することができる。
  62 しかし、たいていは、このシステムコールを呼び出したいのではなく、
  63  \fIlibaio\fP が提供している \fBio_cancel\fP ラッパー関数を呼び出したい
  64 場合がほとんどであろう。
  65
  66 .\" But glibc is confused, since <libaio.h> uses 'io_context_t' to declare
  67 .\" the system call.
  68 \fIlibaio\fP のラッパー関数では \fIctx_id\fP 引き数に別の型
  69 (\fIio_context_t\fP) が使われることに注意すること。
  70 また、\fIlibaio\fP のラッパー関数は、エラーの通知が通常の C ライブラリの
  71 慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列
  72 挙されている値の一つを負にしたもの) が返り値となる点にも注意すること。
  73 \fBsyscall\fP(2) 経由でシステムコールを起動すると、返り値は通常のエラー通
  74 知の慣習に したがってものとなり、エラーの場合には \-1 が返り、 \fIerrno\fP
  75 にエラーを示す (正の) 値が設定される。
  76 .SH 関連項目
  77 .\" .SH AUTHOR
  78 .\" Kent Yoder.
  79 \fBio_destroy\fP(2), \fBio_getevents\fP(2), \fBio_setup\fP(2), \fBio_submit\fP(2),
  80 \fBaio\fP(7)
  81 .SH この文書について
  82 この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.65 の一部
  83 である。プロジェクトの説明とバグ報告に関する情報は
  84 http://www.kernel.org/doc/man\-pages/ に書かれている。