io_destroy man page

io_destroy — destroy an asynchronous I/O context

Synopsis

#include <linux/aio_abi.h> /* Defines needed types */

int io_destroy(aio_context_t ctx_id);

Note: There is no glibc wrapper for this system call; see Notes.

Description

The io_destroy() system call will attempt to cancel all outstanding asynchronous I/O operations against ctx_id, will block on the completion of all operations that could not be canceled, and will destroy the ctx_id.

Return Value

On success, io_destroy() returns 0. For the failure return, see Notes.

Errors

EFAULT
The context pointed to is invalid.
EINVAL
The AIO context specified by ctx_id is invalid.
ENOSYS
io_destroy() is not implemented on this architecture.

Versions

The asynchronous I/O system calls first appeared in Linux 2.5.

Conforming to

io_destroy() is Linux-specific and should not be used in programs that are intended to be portable.

Notes

Glibc 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_destroy() wrapper function provided by libaio.

Note that the libaio wrapper function uses a different type (io_context_t) for the ctx_id argument. Note also that the libaio wrapper does not follow the usual C library conventions for indicating errors: on error it returns a negated error number (the negative of one of the values listed in Errors). If the system call is invoked via syscall(2), then the return value follows the usual conventions for indicating an error: -1, with errno set to a (positive) value that indicates the error.

See Also

io_cancel(2), io_getevents(2), io_setup(2), io_submit(2), aio(7)

Colophon

This page is part of release 4.08 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

Referenced By

aio(7), io_cancel(2), io_getevents(2), io_setup(2), io_submit(2), stress-ng(1), syscalls(2).

2013-04-08 Linux Linux Programmer's Manual