manual/LDP_man-pages/release/man2/io_cancel.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 .\" Japanese Version Copyright (c) 2003 Akihiro MOTOKI, all rights reserved.
   6 .\" Translated Mon Mar  8 2003 by Akihiro MOTOKI <amotoki@dd.iij4u.or.jp>
   7 .\"
   8 .\"WORD:        operation       操作
   9 .\"WORD:        completion queue        完了キュー
  10 .\"
  11 .\" .de Sh \" Subsection
  12 .\" .br
  13 .\" .if t .Sp
  14 .\" .ne 5
  15 .\" .PP
  16 .\" \fB\\$1\fP
  17 .\" .PP
  18 .\" ..
  19 .\" .de Sp \" Vertical space (when we can't use .PP)
  20 .\" .if t .sp .5v
  21 .\" .if n .sp
  22 .\" ..
  23 .\" .de Ip \" List item
  24 .\" .br
  25 .\" .ie \\n(.$>=3 .ne \\$3
  26 .\" .el .ne 3
  27 .\" .IP "\\$1" \\$2
  28 .\" ..
  29 .TH IO_CANCEL 2 2008-06-18 "Linux" "Linux Programmer's Manual"
  30 .SH 名前
  31 io_cancel \- 未処理の非同期 I/O 操作の取り消し
  32 .SH 書式
  33 .nf
  34 .\" .ad l
  35 .\" .hy 0
  36 .\"
  37 .B #include <libaio.h>
  38 .\"#include <linux/aio.h>
  39 .sp
  40 .\" .HP 16
  41 .BI "int io_cancel(aio_context_t " ctx_id ", struct iocb *" iocb ,
  42 .BI "              struct io_event *" result );
  43 .\" .ad
  44 .\" .hy
  45 .sp
  46 \fI\-laio\fP とリンクする。
  47 .fi
  48 .SH 説明
  49 .PP
  50 .BR io_cancel ()
  51 は、過去に
  52 .BR io_submit (2)
  53 を使って登録された非同期 I/O (AIO) 操作の取り消しを行おうとする。
  54 \fIctx_id\fP は、取り消しを行う操作の AIO コンテキストの ID である。
  55 指定した AIO コンテキストが見つかると、
  56 対象のイベントの取り消しが行われ、その後 \fIresult\fP で指されたメモリに
  57 コピーされる (このとき、完了キューへの移動は行われない)。
  58 .SH 返り値
  59 成功した場合、
  60 .BR io_cancel ()
  61 は 0 を返す。
  62 失敗時の返り値については、「注意」の節を参照すること。
  63 .SH エラー
  64 .TP
  65 .B EAGAIN
  66 指定された \fIiocb\fP の取り消しが行われなかった。
  67 .TP
  68 .B EFAULT
  69 データ構造の中に無効なデータを指しているものがある。
  70 .TP
  71 .B EINVAL
  72 \fIctx_id\fP で指定された AIO コンテキストが無効である。
  73 .TP
  74 .B ENOSYS
  75 .BR io_cancel ()
  76 はこのアーキテクチャでは実装されていない。
  77 .SH バージョン
  78 .PP
  79 非同期 I/O システム・コールは 2002年8月に Linux 2.5 で初めて登場した。
  80 .SH 準拠
  81 .PP
  82 .BR io_cancel ()
  83 は Linux 固有であり、移植を想定したプログラムで使用すべきではない。
  84 .SH 注意
  85 glibc はこのシステムコール用のラッパー関数を提供していない。
  86
  87 .I libaio
  88 で
  89 .BR io_cancel ()
  90 用に提供されているラッパー関数は、エラーの通知が通常の C ライブラリの
  91 慣習にしたがっておらず、エラーの場合には負のエラー番号
  92 (エラーの節に列挙されている値の一つを負にしたもの) が返り値となる。
  93 .BR syscall (2)
  94 経由でシステムコールを起動すると、返り値は通常のエラー通知の慣習に
  95 したがってものとなり、エラーの場合には \-1 が返り、
  96 .I errno
  97 にエラーを示す (正の) 値が設定される。
  98 .SH 関連項目
  99 .BR io_destroy (2),
 100 .BR io_getevents (2),
 101 .BR io_setup (2),
 102 .BR io_submit (2),
 103 .BR aio (7)
 104 .\" .SH 注
 105 .\" .PP
 106 .\" 非同期 I/O システム・コールは Benjamin LaHaise が書いた。
 107 .\" .SH 著者
 108 .\" Kent Yoder.