File: io_cancel.2

package info (click to toggle)
manpages-ja 0.5.0.0.20120606-1
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 25,964 kB
  • sloc: perl: 161; makefile: 116
file content (75 lines) | stat: -rw-r--r-- 3,788 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
.\" Copyright (C) 2003 Free Software Foundation, Inc.
.\" This file is distributed according to the GNU General Public License.
.\" See the file COPYING in the top level source directory for details.
.\"
.\"*******************************************************************
.\"
.\" This file was generated with po4a. Translate the source file.
.\"
.\"*******************************************************************
.TH IO_CANCEL 2 2012\-05\-08 Linux "Linux Programmer's Manual"
.SH 名前
io_cancel \- 未処理の非同期 I/O 操作の取り消し
.SH 書式
.nf
\fB#include <linux/aio_abi.h>\fP          /* 必要な型の定義 */

\fBint io_cancel(aio_context_t \fP\fIctx_id\fP\fB, struct iocb *\fP\fIiocb\fP\fB,\fP
\fB              struct io_event *\fP\fIresult\fP\fB);\fP
.fi
.SH 説明
.PP
\fBio_cancel\fP() システムコールは、過去に \fBio_submit\fP(2) を使って登録さ
れた非同期 I/O (AIO) 操作の取り消しを行おうとする。 \fIctx_id\fP 引き数は、
取り消しを行う操作の AIO コンテキストの ID である。指定した AIO コンテ
キストが見つかると、対象のイベントの取り消しが行われ、その後 \fIresult\fP
で指されたメモリに コピーされる (このとき、完了キューへの移動は行われな
い)。
.SH 返り値
成功した場合、 \fBio_cancel\fP()  は 0 を返す。 失敗時の返り値については、「注意」の節を参照すること。
.SH エラー
.TP 
\fBEAGAIN\fP
指定された \fIiocb\fP の取り消しが行われなかった。
.TP 
\fBEFAULT\fP
データ構造の中に無効なデータを指しているものがある。
.TP 
\fBEINVAL\fP
\fIctx_id\fP で指定された AIO コンテキストが無効である。
.TP 
\fBENOSYS\fP
\fBio_cancel\fP()  はこのアーキテクチャでは実装されていない。
.SH バージョン
.PP
非同期 I/O システム・コールは Linux 2.5 で初めて登場した。
.SH 準拠
.PP
\fBio_cancel\fP()  は Linux 固有であり、移植を想定したプログラムで使用すべきではない。
.SH 注意
.\" http://git.fedorahosted.org/git/?p=libaio.git
glibc はこのシステムコールのラッパー関数を提供していない。
\fBsyscall\fP(2) を使ってこのシステムコールを起動することができる。
しかし、たいていは、このシステムコールを呼び出したいのではなく、
 \fIlibaio\fP が提供している \fBio_cancel\fP ラッパー関数を呼び出したい
場合がほとんどであろう。

.\" But glibc is confused, since <libaio.h> uses 'io_context_t' to declare
.\" the system call.
\fIlibaio\fP のラッパー関数では \fIctx_id\fP 引き数に別の型
(\fIio_context_t\fP) が使われることに注意すること。
また、\fIlibaio\fP のラッパー関数は、エラーの通知が通常の C ライブラリの
慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列
挙されている値の一つを負にしたもの) が返り値となる点にも注意すること。
\fBsyscall\fP(2) 経由でシステムコールを起動すると、返り値は通常のエラー通
知の慣習に したがってものとなり、エラーの場合には \-1 が返り、 \fIerrno\fP
にエラーを示す (正の) 値が設定される。
.SH 関連項目
.\" .SH AUTHOR
.\" Kent Yoder.
\fBio_destroy\fP(2), \fBio_getevents\fP(2), \fBio_setup\fP(2), \fBio_submit\fP(2),
\fBaio\fP(7)
.SH この文書について
この man ページは Linux \fIman\-pages\fP プロジェクトのリリース 3.41 の一部
である。プロジェクトの説明とバグ報告に関する情報は
http://www.kernel.org/doc/man\-pages/ に書かれている。