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