Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

aio_cancel(3c) [opensolaris man page]

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

NAME
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)

Check Out this Related Man Page

aio_cancel(2)							System Calls Manual						     aio_cancel(2)

NAME
aio_cancel() - cancel an asynchronous I/O operation SYNOPSIS
DESCRIPTION
The function attempts to cancel the asynchronous I/O request currently outstanding for the referenced by aiocbp or, if aiocbp is any asyn- chronous I/O operations currently outstanding for the file descriptor fildes. If an asynchronous I/O operation is successfully canceled as a result of its status is set to and any signal delivery specified for that operation is performed. Any outstanding requests that cannot be canceled as a result of the remain enqueued and are unaffected by the can- cellation request. Asynchronous I/O operations that are requested as a single logical operation are either completed or canceled atomically. Once any portion of the operation has started, it cannot be canceled. Whether or not and when an asynchronous I/O operation can be canceled depends on the nature of the request. If aiocbp is not fildes is ignored. To use this function, link in the realtime library by specifying on the compiler or linker command line. RETURN VALUE
The function returns one of the following values: The asynchronous I/O operation enqueued for the referenced by aiocbp or all asynchronous I/O operations enqueued for the file referenced by fildes have been successfully canceled. The asynchronous I/O operation enqueued for the referenced by aiocbp or at least one of the asynchronous I/O operations enqueued for the file referenced by fildes have not been canceled. (The function must be used to determine the status of individual operations.) The asynchronous I/O operation enqueued for the referenced by aiocbp or all of the asynchronous I/O operations enqueued for the file referenced by fildes completed before cancellation could be attempted. Failure. The requested cancellation could not be initiated. is set to indicate the error. ERRORS
If detects one of the following error conditions, is set to the indicated value: [EBADF] The aiocbp argument is and the fildes argument is not a valid file descriptor. [EINVAL] There was no asynchronous I/O operation enqueued for the referenced by aiocbp. SEE ALSO
aio_error(2), aio_fsync(2), aio_read(2), aio_return(2), aio_suspend(2), aio_write(2), lio_listio(2), aio(5). STANDARDS CONFORMANCE
aio_cancel(2)
Man Page