2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.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.
|
|
|
|
|
.\"
|
|
|
|
|
.TH AIO_CANCEL 3 2003-11-14 "" "Linux Programmer's Manual"
|
|
|
|
|
.SH NAME
|
|
|
|
|
aio_cancel \- cancel an outstanding asynchronous I/O request
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B "#include <aio.h>"
|
|
|
|
|
.sp
|
|
|
|
|
.BI "int aio_cancel(int " fd ", struct aiocb *" aiocbp );
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR aio_cancel ()
|
2004-11-03 13:51:07 +00:00
|
|
|
function attempts to cancel outstanding asynchronous I/O requests
|
|
|
|
|
for the file descriptor
|
|
|
|
|
.IR fd .
|
|
|
|
|
If
|
|
|
|
|
.I aiocbp
|
2007-06-08 09:56:56 +00:00
|
|
|
is NULL, all such requests are canceled.
|
2007-04-12 22:42:49 +00:00
|
|
|
Otherwise, only the request
|
2004-11-03 13:51:07 +00:00
|
|
|
described by the control block pointed to by
|
|
|
|
|
.I aiocbp
|
2007-06-08 09:56:56 +00:00
|
|
|
is canceled.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
2007-06-08 09:56:56 +00:00
|
|
|
Normal asynchronous notification occurs for canceled requests.
|
2004-11-03 13:51:07 +00:00
|
|
|
The request return status is set to \-1, and the request error status
|
2007-06-22 19:42:52 +00:00
|
|
|
is set to
|
|
|
|
|
.BR ECANCELED .
|
2007-06-08 09:56:56 +00:00
|
|
|
The control block of requests that cannot be canceled is not changed.
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
|
If
|
|
|
|
|
.I aiocbp
|
|
|
|
|
is not NULL, and
|
|
|
|
|
.I fd
|
|
|
|
|
differs from the file descriptor with which the asynchronous operation
|
|
|
|
|
was initiated, unspecified results occur.
|
|
|
|
|
.LP
|
2007-06-08 10:58:53 +00:00
|
|
|
Which operations are cancellable is implementation-defined.
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" FreeBSD: not those on raw disk devices.
|
|
|
|
|
.SH "RETURN VALUE"
|
2007-06-22 19:42:52 +00:00
|
|
|
This function returns
|
|
|
|
|
.B AIO_CANCELED
|
|
|
|
|
if all requests were successfully
|
2007-06-08 09:56:56 +00:00
|
|
|
canceled.
|
2007-06-22 18:25:23 +00:00
|
|
|
It returns
|
|
|
|
|
.B AIO_NOTCANCELED
|
|
|
|
|
when at least one of the
|
2007-06-08 09:56:56 +00:00
|
|
|
requests specified was not canceled because it was in progress.
|
2004-11-03 13:51:07 +00:00
|
|
|
In this case one may check the status of individual requests using
|
|
|
|
|
.BR aio_error (3).
|
2007-06-22 19:42:52 +00:00
|
|
|
This function returns
|
|
|
|
|
.B AIO_ALLDONE
|
|
|
|
|
when all requests had
|
2004-11-03 13:51:07 +00:00
|
|
|
been completed already before this call.
|
|
|
|
|
When some error occurs, \-1 is returned, and
|
|
|
|
|
.I errno
|
|
|
|
|
is set appropriately.
|
|
|
|
|
.SH ERRORS
|
|
|
|
|
.TP
|
|
|
|
|
.B EBADF
|
|
|
|
|
.I fd
|
|
|
|
|
is not a valid file descriptor.
|
|
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:30 +00:00
|
|
|
POSIX.1-2001
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR aio_error (3),
|
|
|
|
|
.BR aio_fsync (3),
|
|
|
|
|
.BR aio_read (3),
|
|
|
|
|
.BR aio_return (3),
|
|
|
|
|
.BR aio_suspend (3),
|
|
|
|
|
.BR aio_write (3)
|
