bsd/man/man2/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: src/lib/libc/sys/aio_cancel.2,v 1.22 2003/01/13 10:37:11 tjr Exp $
  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 .Fo aio_cancel
  39 .Fa "int fildes"
  40 .Fa "struct aiocb *aiocbp"
  41 .Fc
  42 .Sh DESCRIPTION
  43 The
  44 .Fn aio_cancel
  45 system call cancels the outstanding asynchronous
  46 I/O request for the file descriptor specified in
  47 .Fa fildes .
  48 If
  49 .Fa aiocbp
  50 is specified, only that specific asynchronous I/O request is cancelled.
  51 .Pp
  52 Normal asynchronous notification occurs for cancelled requests.
  53 Requests complete with an error result of
  54 .Er ECANCELED .
  55 .Sh RESTRICTIONS
  56 The
  57 .Fn aio_cancel
  58 system call does not cancel asynchronous I/O requests for raw disk devices.
  59 The
  60 .Fn aio_cancel
  61 system call will always return
  62 .Dv AIO_NOTCANCELED
  63 for file descriptors associated with raw disk devices.
  64 .Sh RETURN VALUES
  65 The
  66 .Fn aio_cancel
  67 system call returns -1 to indicate an error, or one of the following:
  68 .Bl -tag -width Dv
  69 .It Bq Dv AIO_ALLDONE
  70 All of the requests meeting the criteria have finished.
  71 .It Bq Dv AIO_CANCELED
  72 All outstanding requests meeting the criteria specified were cancelled.
  73 .It Bq Dv AIO_NOTCANCELED
  74 Some requests were not cancelled, status for the requests should be
  75 checked with
  76 .Xr aio_error 2 .
  77 .El
  78 .Sh ERRORS
  79 An error return from
  80 .Fn aio_cancel
  81 indicates:
  82 .Bl -tag -width Er
  83 .\" ==========
  84 .It Bq Er EBADF
  85 The
  86 .Fa fildes
  87 argument
  88 is not a valid file descriptor.
  89 .El
  90 .Sh SEE ALSO
  91 .Xr aio_error 2 ,
  92 .Xr aio_read 2 ,
  93 .Xr aio_return 2 ,
  94 .Xr aio_suspend 2 ,
  95 .Xr aio_write 2 ,
  96 .Xr aio 4
  97 .Sh STANDARDS
  98 The
  99 .Fn aio_cancel
 100 system call is expected to conform to the
 101 .St -p1003.1
 102 standard.
 103 .Sh HISTORY
 104 The
 105 .Fn aio_cancel
 106 system call first appeared in
 107 .Fx 3.0 .
 108 The first functional implementation of
 109 .Fn aio_cancel
 110 appeared in
 111 .Fx 4.0 .
 112 .Sh AUTHORS
 113 .An -nosplit
 114 This
 115 manual page was originally written by
 116 .An Wes Peters Aq wes@softweyr.com .
 117 .An Christopher M Sedore Aq cmsedore@maxwell.syr.edu
 118 updated it when
 119 .Fn aio_cancel
 120 was implemented for
 121 .Fx 4.0 .