名前
io_cancel - 未処理の非同期 I/O 操作の取り消し
書式
#include <libaio.h>
int io_cancel(aio_context_t ctx_id, struct iocb *iocb,
struct io_event *result);
説明
io_cancel() は、過去に io_submit(2) を使って登録された非同期 I/O (AIO) 操作の取り消しを行おうとする。 ctx_id は、取り消しを行う操作の AIO コンテキストの ID である。 指定した AIO コンテキストが見つかると、 対象のイベントの取り消しが行われ、その後 result で指されたメモリに コピーされる (このとき、完了キューへの移動は行われない)。
返り値
成功した場合、 io_cancel() は 0 を返す。 失敗した場合、「エラー」の節にリストアップされているエラーのいずれか 一つを返す。
エラー
EINVAL | ctx_id で指定された AIO コンテキストが無効である。 |
EFAULT | データ構造の中に無効なデータを指しているものがある。 |
EAGAIN | 指定された iocb の取り消しが行われなかった。 |
ENOSYS | io_cancel() はこのアーキテクチャでは実装されていない。 |
バージョン
非同期 I/O システム・コールは 2002年8月に Linux 2.5 で初めて登場した。
準拠
io_cancel() は Linux 固有であり、移植を想定したプログラムで使用すべきではない。
関連項目