Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

aio_cancel(3) [minix man page]

AIO_CANCEL(3)						     Linux Programmer's Manual						     AIO_CANCEL(3)

aio_cancel - cancel an outstanding asynchronous I/O request SYNOPSIS
#include <aio.h> int aio_cancel(int fd, struct aiocb *aiocbp); Link with -lrt. DESCRIPTION
The aio_cancel() function attempts to cancel outstanding asynchronous I/O requests for the file descriptor fd. If aiocbp is NULL, all such requests are canceled. Otherwise, only the request described by the control block pointed to by aiocbp is canceled. (See aio(7) for a description of the aiocb structure.) Normal asynchronous notification occurs for canceled requests (see aio(7) and sigevent(7)). The request return status (aio_return(3)) is set to -1, and the request error status (aio_error(3)) is set to ECANCELED. The control block of requests that cannot be canceled is not changed. If the request could not be canceled, then it will terminate in the usual way after performing the I/O operation. (In this case, aio_error(3) will return the status EINPROGRESSS.) If aiocbp is not NULL, and fd differs from the file descriptor with which the asynchronous operation was initiated, unspecified results occur. Which operations are cancelable is implementation-defined. RETURN VALUE
The aio_cancel() function returns one of the following values: AIO_CANCELED All requests were successfully canceled. AIO_NOTCANCELED At least one of the requests specified was not canceled because it was in progress. In this case, one may check the status of indi- vidual requests using aio_error(3). AIO_ALLDONE All requests had already been completed before the call. -1 An error occurred. The cause of the error can be found by inspecting errno. ERRORS
EBADF fd is not a valid file descriptor. ENOSYS aio_cancel() is not implemented. VERSIONS
The aio_cancel() function is available since glibc 2.1. ATTRIBUTES
For an explanation of the terms used in this section, see attributes(7). +-------------+---------------+---------+ |Interface | Attribute | Value | +-------------+---------------+---------+ |aio_cancel() | Thread safety | MT-Safe | +-------------+---------------+---------+ CONFORMING TO
POSIX.1-2001, POSIX.1-2008. EXAMPLE
See aio(7). SEE ALSO
aio_error(3), aio_fsync(3), aio_read(3), aio_return(3), aio_suspend(3), aio_write(3), lio_listio(3), aio(7) COLOPHON
This page is part of release 4.15 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 2015-03-02 AIO_CANCEL(3)

Check Out this Related Man Page

aio_cancel(3C)						   Standard C Library Functions 					    aio_cancel(3C)

aio_cancel - cancel asynchronous I/O request SYNOPSIS
#include <aio.h> int aio_cancel(int fildes, struct aiocb *aiocbp); DESCRIPTION
The aio_cancel() function attempts to cancel one or more asynchronous I/O requests currently outstanding against file descriptor fildes. The aiocbp argument points to the asynchronous I/O control block for a particular request to be canceled. If aiocbp is NULL, then all out- standing cancelable asynchronous I/O requests against fildes are canceled. Normal asynchronous notification occurs for asynchronous I/O operations that are successfully canceled. If there are requests that cannot be canceled, then the normal asynchronous completion process takes place for those requests when they are completed. For requested operations that are successfully canceled, the associated error status is set to ECANCELED and the return status is -1. For requested operations that are not successfully canceled, the aiocbp is not modified by aio_cancel(). If aiocbp is not NULL, then if fildes does not have the same value as the file descriptor with which the asynchronous operation was initi- ated, unspecified results occur. RETURN VALUES
The aio_cancel() function returns the value AIO_CANCELED to the calling process if the requested operation(s) were canceled. The value AIO_NOTCANCELED is returned if at least one of the requested operation(s) cannot be canceled because it is in progress. In this case, the state of the other operations, if any, referenced in the call to aio_cancel() is not indicated by the return value of aio_cancel(). The application may determine the state of affairs for these operations by using aio_error(3C). The value AIO_ALLDONE is returned if all of the operations have already completed. Otherwise, the function returns -1 and sets errno to indicate the error. ERRORS
The aio_cancel() function will fail if: EBADF The fildes argument is not a valid file descriptor. ENOSYS The aio_cancel() function is not supported. USAGE
The aio_cancel() function has a transitional interface for 64-bit file offsets. See lf64(5). ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |MT-Safe | +-----------------------------+-----------------------------+ |Standard |See standards(5). | +-----------------------------+-----------------------------+ SEE ALSO
aio.h(3HEAD), signal.h(3HEAD), aio_read(3C), aio_return(3C), attributes(5), lf64(5), standards(5) NOTES
Solaris 2.6 was the first release to support the Asynchronous Input and Output option. Prior to this release, this function always returned -1 and set errno to ENOSYS. SunOS 5.11 5 Feb 2008 aio_cancel(3C)
Man Page

Featured Tech Videos