1.\" Copyright (c) 1999 Softweyr LLC. 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD: src/lib/libc/sys/aio_cancel.2,v 1.5.2.6 2001/12/14 18:34:00 ru Exp $ 26.\" 27.Dd January 19, 2000 28.Dt AIO_CANCEL 3 29.Os 30.Sh NAME 31.Nm aio_cancel 32.Nd cancel an outstanding asynchronous I/O operation (REALTIME) 33.Sh LIBRARY 34.Lb librt 35.Sh SYNOPSIS 36.In aio.h 37.Ft int 38.Fn aio_cancel "int fildes" "struct aiocb * iocb" 39.Sh DESCRIPTION 40The 41.Fn aio_cancel 42function cancels the outstanding asynchronous 43I/O request for the file descriptor specified in 44.Fa fildes . 45If 46.Fa iocb 47is specified, only that specific asynchronous I/O request is cancelled. 48.Pp 49Normal asynchronous notification occurs for cancelled requests. 50Requests complete with an error result of 51.Er ECANCELED . 52.Sh RESTRICTIONS 53The 54.Fn aio_cancel 55function does not cancel asynchronous I/O requests for raw disk devices. 56The 57.Fn aio_cancel 58function will always return 59.Dv AIO_NOTCANCELED 60for file descriptors associated with raw disk devices. 61.Sh RETURN VALUES 62The 63.Fn aio_cancel 64function returns -1 to indicate an error, or one of the following: 65.Bl -tag -width Dv 66.It Bq Dv AIO_CANCELED 67All outstanding requests meeting the criteria specified were cancelled. 68.It Bq Dv AIO_NOTCANCELED 69Some requests were not cancelled, status for the requests should be 70checked with 71.Xr aio_error 3 . 72.It Bq Dv AIO_ALLDONE 73All of the requests meeting the criteria have finished. 74.El 75.Sh ERRORS 76An error return from 77.Fn aio_cancel 78indicates: 79.Bl -tag -width Er 80.It Bq Er EBADF 81.Fa fildes 82is an invalid file descriptor. 83.El 84.Sh SEE ALSO 85.Xr aio_error 3 , 86.Xr aio_read 3 , 87.Xr aio_return 3 , 88.Xr aio_suspend 3 , 89.Xr aio_write 3 90.Sh STANDARDS 91The 92.Fn aio_cancel 93function is expected to conform to the 94.St -p1003.2 95standard. 96.Sh HISTORY 97The 98.Fn aio_cancel 99function first appeared in 100.Fx 3.0 . 101The first functional implementation of 102.Fn aio_cancel 103appeared in 104.Fx 4.0 . 105.Sh AUTHORS 106.An -nosplit 107This manual page was originally written by 108.An Wes Peters Aq Mt wes@softweyr.com . 109.An Christopher M Sedore Aq Mt cmsedore@maxwell.syr.edu 110updated it when 111.Fn aio_cancel 112was implemented for 113.Fx 4.0 . 114