Name
aio_cancel — cancel an outstanding asynchronous I/O request
Synopsis
#include <aio.h>
int
aio_cancel( |
int fd, |
struct aiocb *aiocbp); |
![[Note]](../stylesheet/note.png) |
Note |
|---|---|
|
Link with |
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 individual 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.
ATTRIBUTES
For an explanation of the terms used in this section, see attributes(7).
| Interface | Attribute | Value |
aio_cancel() |
Thread safety | MT-Safe |
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.07 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/.
|
Copyright (c) 2003 Andries Brouwer (aebcwi.nl) %%%LICENSE_START(GPLv2+_DOC_FULL) 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, see <http://www.gnu.org/licenses/>. %%%LICENSE_END |