Name

aio_cancel — cancel an outstanding asynchronous I/O request

Synopsis

#include <aio.h>
int aio_cancel( int fd,
  struct aiocb *aiocbp);
 
[Note] Note

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.

Normal asynchronous notification occurs for canceled requests. The request return status is set to −1, and the request error status is set to ECANCELED. The control block of requests that cannot be canceled is not changed.

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 cancellable is implementation-defined.

RETURN VALUE

This function returns AIO_CANCELED if all requests were successfully canceled. It returns AIO_NOTCANCELED when at least one of the requests specified was not canceled because it was in progress. In this case one may check the status of individual requests using aio_error(3). This function returns AIO_ALLDONE when all requests had been completed already before this call. When some error occurs, −1 is returned, and errno is set appropriately.

ERRORS

EBADF

fd is not a valid file descriptor.

CONFORMING TO

POSIX.1-2001.

SEE ALSO

aio_error(3), aio_fsync(3), aio_read(3), aio_return(3), aio_suspend(3), aio_write(3)

COLOPHON

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


  Copyright (c) 2003 Andries Brouwer (aebcwi.nl)

This is free documentation; you can redistribute it and/or
modify it under the terms of the GNU General Public License as
published by the Free Software Foundation; either version 2 of
the License, or (at your option) any later version.

The GNU General Public License's references to "object code"
and "executables" are to be interpreted as the output of any
document formatting or typesetting system, including
intermediate and printed output.

This manual is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public
License along with this manual; if not, write to the Free
Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
USA.