aio_cancel(2)

aio_cancel2

Cancel an outstanding asynchronous i/o operation (realtime)

Usage

#include <aio.h>

int

aio_cancel(int fildes, struct aiocb * iocb);

Library

Standard C Library (libc, -lc)

Overview

The aio_cancel() system call cancels the outstanding asynchronous I/O request for the file descriptor specified in fildes. If iocb is specified, only that specific asynchronous I/O request is cancelled.

Normal asynchronous notification occurs for cancelled requests. Requests complete with an error result of ECANCELED.

Restrictions

The aio_cancel() system call does not cancel asynchronous I/O requests for raw disk devices. The aio_cancel() system call will always return AIO_NOTCANCELED for file descriptors associated with raw disk devices.

Return values

The aio_cancel() system call returns -1 to indicate an error, or one of the following:

[AIO_CANCELED]

All outstanding requests meeting the criteria specified were cancelled.

[AIO_NOTCANCELED]

Some requests were not cancelled, status for the requests should be checked with aio_error(2).

[AIO_ALLDONE]

All of the requests meeting the criteria have finished.

Errors

An error return from aio_cancel() indicates:

[EBADF]

The fildes argument is an invalid file descriptor.

Standards

The aio_cancel() system call is expected to conform to the IEEE Std 1003.1 (“POSIX.1”) standard.

History

The aio_cancel() system call first appeared in FreeBSD 3.0. The first functional implementation of aio_cancel() appeared in FreeBSD 4.0.

Authors

This manual page was originally written by Wes Peters ⟨[email protected]⟩. Christopher M Sedore ⟨[email protected]⟩ updated it when aio_cancel() was implemented for FreeBSD 4.0.

From freebsd-manpages 6.0-5 in Debian 4.0 (Etch). Parsed by carta from the page's mdoc source.