|IO_CANCEL(2)||Linux Programmer's Manual||IO_CANCEL(2)|
NAMEio_cancel - cancel an outstanding asynchronous I/O operation
#include <linux/aio_abi.h> /* Defines needed types */
int io_cancel(aio_context_t ctx_id, struct iocb *iocb,
struct io_event *result);
Note: There is no glibc wrapper for this system call; see NOTES.
DESCRIPTIONThe io_cancel() system call attempts to cancel an asynchronous I/O operation previously submitted with io_submit(2). The iocb argument describes the operation to be canceled and the ctx_id argument is the AIO context to which the operation was submitted. If the operation is successfully canceled, the event will be copied into the memory pointed to by result without being placed into the completion queue.
RETURN VALUEOn success, io_cancel() returns 0. For the failure return, see NOTES.
- The iocb specified was not canceled.
- One of the data structures points to invalid data.
- The AIO context specified by ctx_id is invalid.
- io_cancel() is not implemented on this architecture.
VERSIONSThe asynchronous I/O system calls first appeared in Linux 2.5.
CONFORMING TOio_cancel() is Linux-specific and should not be used in programs that are intended to be portable.
NOTESGlibc does not provide a wrapper function for this system call. You could invoke it using syscall(2). But instead, you probably want to use the io_cancel() wrapper function provided by libaio.
SEE ALSOio_destroy(2), io_getevents(2), io_setup(2), io_submit(2), aio(7)
COLOPHONThis page is part of release 3.53 of the Linux man-pages project. A description of the project, and information about reporting bugs, can be found at http://www.kernel.org/doc/man-pages/.