aio_cancel(3) [netbsd man page]

AIO_CANCEL(3)						   BSD Library Functions Manual 					     AIO_CANCEL(3)

NAME

     aio_cancel -- cancel an outstanding asynchronous I/O operation (REALTIME)

LIBRARY

     POSIX Real-time Library (librt, -lrt)

SYNOPSIS

     #include <aio.h>

     int
     aio_cancel(int fildes, struct aiocb * aiocbp);

DESCRIPTION

     The aio_cancel() system call cancels the outstanding asynchronous I/O request for the file descriptor specified in fildes.  If aiocbp 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.

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(3).

     [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.

SEE ALSO

     aio(3)

STANDARDS

     The aio_cancel() system call is expected to conform to the IEEE Std 1003.1-2001 (``POSIX.1'') standard.

HISTORY

     The aio_cancel() system call first appeared in NetBSD 5.0.

BSD
								   May 17, 2010 							       BSD

aio_cancel(3)						     Library Functions Manual						     aio_cancel(3)

NAME

       aio_cancel - Cancels one or more asynchronous I/O requests pending against the specified file descriptor (P1003.1b)

LIBRARY

       Asynchronous I/O Library (libaio, libaio_raw)

SYNOPSIS

       #include <aio.h>

       int aio_cancel (
       int fildes,
       struct aiocb *aiocbp);

PARAMETERS

       fildes	   The file descriptor against which outstanding asynchronous I/O operations are canceled.

       *aiocbp	   A  pointer  to  the address of the aiocb structure for a particular request to be canceled. If the aiocbp argument is NULL, all
		   queued outstanding asynchronous I/O requests against the file descriptor are canceled.

DESCRIPTION

       The aio_cancel function cancels asynchronous I/O requests.  Normal signal delivery occurs for asynchronous I/O operations that are success-
       fully  canceled.  If a request cannot be canceled, then the normal asynchronous completion process takes place for those requests when they
       are completed.

RETURN VALUES

       On a successful call to the aio_cancel function, the requested operation is canceled and AIO_CANCELED is returned.  If at least one of  the
       requested  operations  is not canceled because it is in progress, AIO_NOTCANCELED is returned. If all the operations completed prior to the
       cancel request, AIO_ALLDONE is returned.

       On an unsuccessful call, a value of -1 is returned and errno is set to indicate that an error occurred.	Note  that  the  value	of  -1	is
       returned only if the call itself failed.

ERRORS

       The aio_cancel function fails under the following conditions:

       [EBADF]	      The fildes argument is not a valid file descriptor.

RELATED INFORMATION

       Functions: aio_group_completion_np(3), aio_read(3), aio_results_np(3), aio_write(3), aio_suspend(3)

       Guide to Realtime Programming delim off

																     aio_cancel(3)