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