projects / thirdparty / man-pages.git / blame
| Commit | Line | Data |
|---|---|---|
| fea681da MK |
1 | .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl) |
| 2 | .\" | |
| 3 | .\" This is free documentation; you can redistribute it and/or | |
| 4 | .\" modify it under the terms of the GNU General Public License as | |
| 5 | .\" published by the Free Software Foundation; either version 2 of | |
| 6 | .\" the License, or (at your option) any later version. | |
| 7 | .\" | |
| 8 | .\" The GNU General Public License's references to "object code" | |
| 9 | .\" and "executables" are to be interpreted as the output of any | |
| 10 | .\" document formatting or typesetting system, including | |
| 11 | .\" intermediate and printed output. | |
| 12 | .\" | |
| 13 | .\" This manual is distributed in the hope that it will be useful, | |
| 14 | .\" but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 15 | .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 16 | .\" GNU General Public License for more details. | |
| 17 | .\" | |
| 18 | .\" You should have received a copy of the GNU General Public | |
| 19 | .\" License along with this manual; if not, write to the Free | |
| 20 | .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111, | |
| 21 | .\" USA. | |
| 22 | .\" | |
| 23 | .TH AIO_CANCEL 3 2003-11-14 "" "Linux Programmer's Manual" | |
| 24 | .SH NAME | |
| 25 | aio_cancel \- cancel an outstanding asynchronous I/O request | |
| 26 | .SH SYNOPSIS | |
| fea681da MK |
27 | .B "#include <aio.h>" |
| 28 | .sp | |
| 29 | .BI "int aio_cancel(int " fd ", struct aiocb *" aiocbp ); | |
| fea681da MK |
30 | .SH DESCRIPTION |
| 31 | The | |
| e511ffb6 | 32 | .BR aio_cancel () |
| fea681da MK |
33 | function attempts to cancel outstanding asynchronous I/O requests |
| 34 | for the file descriptor | |
| 35 | .IR fd . | |
| 36 | If | |
| 37 | .I aiocbp | |
| d9bfdb9c | 38 | is NULL, all such requests are canceled. |
| c13182ef | 39 | Otherwise, only the request |
| fea681da MK |
40 | described by the control block pointed to by |
| 41 | .I aiocbp | |
| d9bfdb9c | 42 | is canceled. |
| fea681da | 43 | .LP |
| d9bfdb9c | 44 | Normal asynchronous notification occurs for canceled requests. |
| fea681da | 45 | The request return status is set to \-1, and the request error status |
| 2f0af33b MK |
46 | is set to |
| 47 | .BR ECANCELED . | |
| d9bfdb9c | 48 | The control block of requests that cannot be canceled is not changed. |
| fea681da MK |
49 | .LP |
| 50 | If | |
| 51 | .I aiocbp | |
| 52 | is not NULL, and | |
| 53 | .I fd | |
| 54 | differs from the file descriptor with which the asynchronous operation | |
| 55 | was initiated, unspecified results occur. | |
| 56 | .LP | |
| eb1af896 | 57 | Which operations are cancellable is implementation-defined. |
| fea681da MK |
58 | .\" FreeBSD: not those on raw disk devices. |
| 59 | .SH "RETURN VALUE" | |
| 2f0af33b MK |
60 | This function returns |
| 61 | .B AIO_CANCELED | |
| 62 | if all requests were successfully | |
| d9bfdb9c | 63 | canceled. |
| 1274071a MK |
64 | It returns |
| 65 | .B AIO_NOTCANCELED | |
| 66 | when at least one of the | |
| d9bfdb9c | 67 | requests specified was not canceled because it was in progress. |
| fea681da MK |
68 | In this case one may check the status of individual requests using |
| 69 | .BR aio_error (3). | |
| 2f0af33b MK |
70 | This function returns |
| 71 | .B AIO_ALLDONE | |
| 72 | when all requests had | |
| fea681da MK |
73 | been completed already before this call. |
| 74 | When some error occurs, \-1 is returned, and | |
| 75 | .I errno | |
| 76 | is set appropriately. | |
| 77 | .SH ERRORS | |
| 78 | .TP | |
| 79 | .B EBADF | |
| 80 | .I fd | |
| 81 | is not a valid file descriptor. | |
| 82 | .SH "CONFORMING TO" | |
| 68e1685c | 83 | POSIX.1-2001 |
| fea681da MK |
84 | .SH "SEE ALSO" |
| 85 | .BR aio_error (3), | |
| 86 | .BR aio_fsync (3), | |
| 87 | .BR aio_read (3), | |
| 88 | .BR aio_return (3), | |
| 89 | .BR aio_suspend (3), | |
| 90 | .BR aio_write (3) |