名前¶

io_cancel - 未処理の非同期 I/O 操作の取り消し

書式¶

#include <libaio.h>

int io_cancel(aio_context_t ctx_id, struct iocb *iocb,
              struct io_event *result);

-laio とリンクする。

説明¶

io_cancel() は、過去に io_submit(2) を使って登録された非同期 I/O (AIO) 操作の取り消しを行おうとする。 ctx_id は、取り消しを行う操作の AIO コンテキストの ID である。 指定した AIO コンテキストが見つかると、 対象のイベントの取り消しが行われ、その後 result で指されたメモリに コピーされる (このとき、完了キューへの移動は行われない)。

返り値¶

成功した場合、 io_cancel() は 0 を返す。 失敗時の返り値については、「注意」の節を参照すること。

エラー¶

EAGAIN

指定された iocb の取り消しが行われなかった。

EFAULT

データ構造の中に無効なデータを指しているものがある。

EINVAL

ctx_id で指定された AIO コンテキストが無効である。

ENOSYS

io_cancel() はこのアーキテクチャでは実装されていない。

バージョン¶

非同期 I/O システム・コールは 2002年8月に Linux 2.5 で初めて登場した。

準拠¶

io_cancel() は Linux 固有であり、移植を想定したプログラムで使用すべきではない。

注意¶

glibc はこのシステムコール用のラッパー関数を提供していない。

libaio で io_cancel() 用に提供されているラッパー関数は、エラーの通知が通常の C ライブラリの 慣習にしたがっておらず、エラーの場合には負のエラー番号 (エラーの節に列挙されている値の一つを負にしたもの) が返り値となる。 syscall(2) 経由でシステムコールを起動すると、返り値は通常のエラー通知の慣習に したがってものとなり、エラーの場合には -1 が返り、 errno にエラーを示す (正の) 値が設定される。

関連項目¶

io_destroy(2), io_getevents(2), io_setup(2), io_submit(2)