draft/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 .\"O .SH NAME
  31 .\"O io_cancel \- cancel an outstanding asynchronous I/O operation
  32 .SH 名前
  33 io_cancel \- 未処理の非同期 I/O 操作の取り消し
  34 .\"O .SH "SYNOPSIS"
  35 .SH 書式
  36 .nf
  37 .\" .ad l
  38 .\" .hy 0
  39 .\"
  40 .B #include <libaio.h>
  41 .\"#include <linux/aio.h>
  42 .sp
  43 .\" .HP 16
  44 .BI "int io_cancel(aio_context_t " ctx_id ", struct iocb *" iocb ,
  45 .BI "              struct io_event *" result );
  46 .\" .ad
  47 .\" .hy
  48 .sp
  49 .\"O Link with \fI\-laio\fP.
  50 \fI\-laio\fP とリンクする。
  51 .fi
  52 .\"O .SH "DESCRIPTION"
  53 .SH 説明
  54 .PP
  55 .\"O .BR io_cancel ()
  56 .\"O attempts to cancel an asynchronous I/O operation previously submitted with
  57 .\"O .BR io_submit (2).
  58 .\"O \fIctx_id\fP is the AIO context ID of the operation to be canceled.
  59 .\"O If the AIO context is found, the event will be canceled and then copied
  60 .\"O into the memory pointed to by \fIresult\fP without being placed
  61 .\"O into the completion queue.
  62 .BR io_cancel ()
  63 は、過去に
  64 .BR io_submit (2)
  65 を使って登録された非同期 I/O (AIO) 操作の取り消しを行おうとする。
  66 \fIctx_id\fP は、取り消しを行う操作の AIO コンテキストの ID である。
  67 指定した AIO コンテキストが見つかると、
  68 対象のイベントの取り消しが行われ、その後 \fIresult\fP で指されたメモリに
  69 コピーされる (このとき、完了キューへの移動は行われない)。
  70 .\"O .SH "RETURN VALUE"
  71 .SH 返り値
  72 .\"O On success,
  73 .\"O .BR io_cancel ()
  74 .\"O returns 0.
  75 .\"O For the failure return, see NOTES.
  76 成功した場合、
  77 .BR io_cancel ()
  78 は 0 を返す。
  79 失敗時の返り値については、「注意」の節を参照すること。
  80 .\"O .SH "ERRORS"
  81 .SH エラー
  82 .TP
  83 .B EAGAIN
  84 .\"O The \fIiocb\fP specified was not canceled.
  85 指定された \fIiocb\fP の取り消しが行われなかった。
  86 .TP
  87 .B EFAULT
  88 .\"O One of the data structures points to invalid data.
  89 データ構造の中に無効なデータを指しているものがある。
  90 .TP
  91 .B EINVAL
  92 .\"O The AIO context specified by \fIctx_id\fP is invalid.
  93 \fIctx_id\fP で指定された AIO コンテキストが無効である。
  94 .TP
  95 .B ENOSYS
  96 .\"O .BR io_cancel ()
  97 .\"O is not implemented on this architecture.
  98 .BR io_cancel ()
  99 はこのアーキテクチャでは実装されていない。
 100 .\"O .SH "VERSIONS"
 101 .SH バージョン
 102 .PP
 103 .\"O The asynchronous I/O system calls first appeared in Linux 2.5, August 2002.
 104 非同期 I/O システム・コールは 2002年8月に Linux 2.5 で初めて登場した。
 105 .\"O .SH "CONFORMING TO"
 106 .SH 準拠
 107 .PP
 108 .\"O .BR io_cancel ()
 109 .\"O is Linux-specific and should not be used
 110 .\"O in programs that are intended to be portable.
 111 .BR io_cancel ()
 112 は Linux 固有であり、移植を想定したプログラムで使用すべきではない。
 113 .\"O .SH NOTES
 114 .SH 注意
 115 .\"O Glibc does not provide a wrapper function for this system call.
 116 glibc はこのシステムコール用のラッパー関数を提供していない。
 117
 118 .\"O The wrapper provided in
 119 .\"O .I libaio
 120 .\"O for
 121 .\"O .BR io_cancel ()
 122 .\"O does not follow the usual C library conventions for indicating error:
 123 .\"O on error it returns a negated error number
 124 .\"O (the negative of one of the values listed in ERRORS).
 125 .\"O If the system call is invoked via
 126 .\"O .BR syscall (2),
 127 .\"O then the return value follows the usual conventions for
 128 .\"O indicating an error: \-1, with
 129 .\"O .I errno
 130 .\"O set to a (positive) value that indicates the error.
 131 .I libaio
 132 で
 133 .BR io_cancel ()
 134 用に提供されているラッパー関数は、エラーの通知が通常の C ライブラリの
 135 慣習にしたがっておらず、エラーの場合には負のエラー番号
 136 (エラーの節に列挙されている値の一つを負にしたもの) が返り値となる。
 137 .BR syscall (2)
 138 経由でシステムコールを起動すると、返り値は通常のエラー通知の慣習に
 139 したがってものとなり、エラーの場合には \-1 が返り、
 140 .I errno
 141 にエラーを示す (正の) 値が設定される。
 142 .\"O .SH "SEE ALSO"
 143 .SH 関連項目
 144 .BR io_destroy (2),
 145 .BR io_getevents (2),
 146 .BR io_setup (2),
 147 .BR io_submit (2),
 148 .BR aio (7)
 149 .\"O .\" .SH "NOTES"
 150 .\" .SH 注
 151 .\" .PP
 152 .\"O .\" The asynchronous I/O system calls were written by Benjamin LaHaise.
 153 .\" 非同期 I/O システム・コールは Benjamin LaHaise が書いた。
 154 .\"O .\" .SH AUTHOR
 155 .\" .SH 著者
 156 .\" Kent Yoder.