freebsd/lib/libc/sys/aio_cancel.2

.\" Copyright (c) 1999 Softweyr LLC.
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd January 19, 2000
.Dt AIO_CANCEL 2
.Os
.Sh NAME
.Nm aio_cancel
.Nd cancel an outstanding asynchronous I/O operation (REALTIME)
.Sh LIBRARY
.Lb libc
.Sh SYNOPSIS
.In aio.h
.Ft int
.Fn aio_cancel "int fildes" "struct aiocb * iocb"
.Sh DESCRIPTION
The
.Fn aio_cancel
system call cancels the outstanding asynchronous
I/O request for the file descriptor specified in
.Fa fildes .
If
.Fa iocb
is specified, only that specific asynchronous I/O request is cancelled.
.Pp
Normal asynchronous notification occurs for cancelled requests.
Requests complete with an error result of
.Er ECANCELED .
.Sh RESTRICTIONS
The
.Fn aio_cancel
system call does not cancel asynchronous I/O requests for raw disk devices.
The
.Fn aio_cancel
system call will always return
.Dv AIO_NOTCANCELED
for file descriptors associated with raw disk devices.
.Sh RETURN VALUES
The
.Fn aio_cancel
system call returns -1 to indicate an error, or one of the following:
.Bl -tag -width Dv
.It Bq Dv AIO_CANCELED
All outstanding requests meeting the criteria specified were cancelled.
.It Bq Dv AIO_NOTCANCELED
Some requests were not cancelled, status for the requests should be
checked with
.Xr aio_error 2 .
.It Bq Dv AIO_ALLDONE
All of the requests meeting the criteria have finished.
.El
.Sh ERRORS
An error return from
.Fn aio_cancel
indicates:
.Bl -tag -width Er
.It Bq Er EBADF
The
.Fa fildes
argument
is an invalid file descriptor.
.El
.Sh SEE ALSO
.Xr aio_error 2 ,
.Xr aio_read 2 ,
.Xr aio_return 2 ,
.Xr aio_suspend 2 ,
.Xr aio_write 2 ,
.Xr aio 4
.Sh STANDARDS
The
.Fn aio_cancel
system call is expected to conform to the
.St -p1003.1
standard.
.Sh HISTORY
The
.Fn aio_cancel
system call first appeared in
.Fx 3.0 .
The first functional implementation of
.Fn aio_cancel
appeared in
.Fx 4.0 .
.Sh AUTHORS
.An -nosplit
This
manual page was originally written by
.An Wes Peters Aq wes@softweyr.com .
.An Christopher M Sedore Aq cmsedore@maxwell.syr.edu
updated it when
.Fn aio_cancel
was implemented for
.Fx 4.0 .
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.\" Copyright (c) 1999 Softweyr LLC.`
			`.\" All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.\"`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.Dd January 19, 2000`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Dt AIO_CANCEL 2`
			`.Os`
			`.Sh NAME`
			`.Nm aio_cancel`
Fix typos/spelling errors. 1999-07-01 21:09:57 +00:00			`.Nd cancel an outstanding asynchronous I/O operation (REALTIME)`
Introduce ".Lb" macro to libc manpages. More libraries manpages updates following. 2000-04-21 09:42:15 +00:00			`.Sh LIBRARY`
			`.Lb libc`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Sh SYNOPSIS`
mdoc(7) police: Use the new .In macro for #include statements. 2001-10-01 16:09:29 +00:00			`.In aio.h`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Ft int`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.Fn aio_cancel "int fildes" "struct aiocb * iocb"`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Fn aio_cancel`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call cancels the outstanding asynchronous`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`I/O request for the file descriptor specified in`
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd'' 2000-06-23 05:05:44 +00:00			`.Fa fildes .`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`If`
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd'' 2000-06-23 05:05:44 +00:00			`.Fa iocb`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`is specified, only that specific asynchronous I/O request is cancelled.`
			`.Pp`
Remove the only hard sentence break in the file. 2000-11-24 10:48:02 +00:00			`Normal asynchronous notification occurs for cancelled requests.`
			`Requests complete with an error result of`
mdoc(7) police: Er macro usage cleanup. 2000-11-22 16:02:00 +00:00			`.Er ECANCELED .`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.Sh RESTRICTIONS`
			`The`
			`.Fn aio_cancel`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call does not cancel asynchronous I/O requests for raw disk devices.`
Remove the only hard sentence break in the file. 2000-11-24 10:48:02 +00:00			`The`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Fn aio_cancel`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call will always return`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.Dv AIO_NOTCANCELED`
			`for file descriptors associated with raw disk devices.`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Sh RETURN VALUES`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`The`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Fn aio_cancel`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call returns -1 to indicate an error, or one of the following:`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.Bl -tag -width Dv`
			`.It Bq Dv AIO_CANCELED`
			`All outstanding requests meeting the criteria specified were cancelled.`
			`.It Bq Dv AIO_NOTCANCELED`
			`Some requests were not cancelled, status for the requests should be`
Replace a `manual(section)' reference with a proper .Xr statement. 2000-05-31 21:12:08 +00:00			`checked with`
			`.Xr aio_error 2 .`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.It Bq Dv AIO_ALLDONE`
			`All of the requests meeting the criteria have finished.`
			`.El`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Sh ERRORS`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`An error return from`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Fn aio_cancel`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`indicates:`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Bl -tag -width Er`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.It Bq Er EBADF`
mdoc(7) police: "The .Fa argument.". 2002-12-19 09:40:28 +00:00			`The`
Replace .Va, .Ar and .Nm with .Fa or .Va where necessary, examples: ``.Ar errno'' -> ``.Va errno'' ``.Nm ops'' -> ``.Fa ops'' ``.Va fd'' -> ``.Fa fd'' 2000-06-23 05:05:44 +00:00			`.Fa fildes`
mdoc(7) police: "The .Fa argument.". 2002-12-19 09:40:28 +00:00			`argument`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`is an invalid file descriptor.`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.El`
Explain to users that they may want to kldload aio. Move Xref sections. Submitted by: Craig Rodrigues <rodrigc@attbi.com> 2002-10-22 16:12:27 +00:00			`.Sh SEE ALSO`
			`.Xr aio_error 2 ,`
			`.Xr aio_read 2 ,`
			`.Xr aio_return 2 ,`
			`.Xr aio_suspend 2 ,`
			`.Xr aio_write 2 ,`
* Modernize aio(4), providing instructions for static and dynamic kernel linking. * Fix disorder in the SEE ALSO sections of aio_(2). Remove unnecessary cross-references from the SEE ALSO sections of aio_(2); config(8), kldload(8) and kldunload(8) are cross-referenced from aio(4). Remove the KERNEL OPTIONS sections from aio_*(2), now that these pages cross-reference aio(4), which contains suitable kernel linking reference material. 2002-10-24 12:57:05 +00:00			`.Xr aio 4`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Sh STANDARDS`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`The`
			`.Fn aio_cancel`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call is expected to conform to the`
Refer to 1003.1 instead of 1003.2 in the Standards section. 2003-01-13 10:37:11 +00:00			`.St -p1003.1`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`standard.`
			`.Sh HISTORY`
			`The`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.Fn aio_cancel`
mdoc(7) police: Tidy up the syscall language. Stop calling system calls "function calls". Use "The .Fn system call" a-la "The .Nm utility". When referring to a non-BSD implementation in the HISTORY section, call syscall a function, to be safe. 2002-12-18 09:22:32 +00:00			`system call first appeared in`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.Fx 3.0 .`
Remove the only hard sentence break in the file. 2000-11-24 10:48:02 +00:00			`The first functional implementation of`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.Fn aio_cancel`
			`appeared in`
			`.Fx 4.0 .`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlines in mdoc(7) - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexy M. Zelkin <phantom@cris.net> 1999-08-15 09:51:25 +00:00			`.Sh AUTHORS`
log 2000-11-22 09:23:54 +00:00			`.An -nosplit`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`This`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`manual page was originally written by`
Add mising aio_* man pages. Fixed a minor typo in aio_read.2, and "corrected" statement of Posix conformance. 1999-07-01 19:58:12 +00:00			`.An Wes Peters Aq wes@softweyr.com .`
Add a man page for aio_waitcomplete(). Update the aio_cancel() man page to reflect the fact that aio_cancel() works now. Submitted by: Christopher Sedore <cmsedore@maxwell.syr.edu> 2000-03-21 10:25:22 +00:00			`.An Christopher M Sedore Aq cmsedore@maxwell.syr.edu`
			`updated it when`
			`.Fn aio_cancel`
Replace ``FreeBSD 4.0'' with ``.Fx 4.0'' and remove a useless empty line at the end of the file. 2000-06-23 03:50:32 +00:00			`was implemented for`
			`.Fx 4.0 .`