aio_cancel(2) [debian man page]

AIO_CANCEL(2)						      BSD System Calls Manual						     AIO_CANCEL(2)

NAME

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

LIBRARY

     Standard C Library (libc, -lc)

SYNOPSIS

     #include <aio.h>

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

DESCRIPTION

     The aio_cancel() system call cancels the outstanding asynchronous I/O request for the file descriptor specified in fildes.  If iocb is speci-
     fied, only that specific asynchronous I/O request is cancelled.

     Normal asynchronous notification occurs for cancelled requests.  Requests complete with an error result of ECANCELED.

RESTRICTIONS

     The aio_cancel() system call does not cancel asynchronous I/O requests for raw disk devices.  The aio_cancel() system call will always return
     AIO_NOTCANCELED for file descriptors associated with raw disk devices.

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

     [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_error(2), aio_read(2), aio_return(2), aio_suspend(2), aio_write(2), aio(4)

STANDARDS

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

HISTORY

     The aio_cancel() system call first appeared in FreeBSD 3.0.  The first functional implementation of aio_cancel() appeared in FreeBSD 4.0.

AUTHORS

     This manual page was originally written by Wes Peters <wes@softweyr.com>.	Christopher M Sedore <cmsedore@maxwell.syr.edu> updated it when
     aio_cancel() was implemented for FreeBSD 4.0.

BSD
								 January 19, 2000							       BSD

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

NAME

       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 https://www.kernel.org/doc/man-pages/.

								    2015-03-02							     AIO_CANCEL(3)