]> CyberLeo.Net >> Repos - FreeBSD/releng/9.2.git/blob - lib/libc/sys/aio_cancel.2
- Copy stable/9 to releng/9.2 as part of the 9.2-RELEASE cycle.
[FreeBSD/releng/9.2.git] / lib / libc / sys / aio_cancel.2
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$
26 .\"
27 .Dd January 19, 2000
28 .Dt AIO_CANCEL 2
29 .Os
30 .Sh NAME
31 .Nm aio_cancel
32 .Nd cancel an outstanding asynchronous I/O operation (REALTIME)
33 .Sh LIBRARY
34 .Lb libc
35 .Sh SYNOPSIS
36 .In aio.h
37 .Ft int
38 .Fn aio_cancel "int fildes" "struct aiocb *iocb"
39 .Sh DESCRIPTION
40 The
41 .Fn aio_cancel
42 system call cancels the outstanding asynchronous
43 I/O request for the file descriptor specified in
44 .Fa fildes .
45 If
46 .Fa iocb
47 is specified, only that specific asynchronous I/O request is cancelled.
48 .Pp
49 Normal asynchronous notification occurs for cancelled requests.
50 Requests complete with an error result of
51 .Er ECANCELED .
52 .Sh RESTRICTIONS
53 The
54 .Fn aio_cancel
55 system call does not cancel asynchronous I/O requests for raw disk devices.
56 The
57 .Fn aio_cancel
58 system call will always return
59 .Dv AIO_NOTCANCELED
60 for file descriptors associated with raw disk devices.
61 .Sh RETURN VALUES
62 The
63 .Fn aio_cancel
64 system call returns -1 to indicate an error, or one of the following:
65 .Bl -tag -width Dv
66 .It Bq Dv AIO_CANCELED
67 All outstanding requests meeting the criteria specified were cancelled.
68 .It Bq Dv AIO_NOTCANCELED
69 Some requests were not cancelled, status for the requests should be
70 checked with
71 .Xr aio_error 2 .
72 .It Bq Dv AIO_ALLDONE
73 All of the requests meeting the criteria have finished.
74 .El
75 .Sh ERRORS
76 An error return from
77 .Fn aio_cancel
78 indicates:
79 .Bl -tag -width Er
80 .It Bq Er EBADF
81 The
82 .Fa fildes
83 argument
84 is an invalid file descriptor.
85 .El
86 .Sh SEE ALSO
87 .Xr aio_error 2 ,
88 .Xr aio_read 2 ,
89 .Xr aio_return 2 ,
90 .Xr aio_suspend 2 ,
91 .Xr aio_write 2 ,
92 .Xr aio 4
93 .Sh STANDARDS
94 The
95 .Fn aio_cancel
96 system call is expected to conform to the
97 .St -p1003.1
98 standard.
99 .Sh HISTORY
100 The
101 .Fn aio_cancel
102 system call first appeared in
103 .Fx 3.0 .
104 The first functional implementation of
105 .Fn aio_cancel
106 appeared in
107 .Fx 4.0 .
108 .Sh AUTHORS
109 .An -nosplit
110 This
111 manual page was originally written by
112 .An Wes Peters Aq wes@softweyr.com .
113 .An Christopher M Sedore Aq cmsedore@maxwell.syr.edu
114 updated it when
115 .Fn aio_cancel
116 was implemented for
117 .Fx 4.0 .