lib/librt/aio_cancel.3

   1 .\" $NetBSD: aio_cancel.3,v 1.2 2007/05/05 19:16:01 ad Exp $
   2 .\"
   3 .\" Copyright (c) 1999 Softweyr LLC.
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND
  16 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE
  19 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25 .\" SUCH DAMAGE.
  26 .\"
  27 .\" $FreeBSD: /repoman/r/ncvs/src/lib/libc/sys/aio_cancel.2,v 1.22 2003/01/13 10:37:11 tjr Exp $
  28 .\"
  29 .Dd May 4, 2007
  30 .Dt AIO_CANCEL 3
  31 .Os
  32 .Sh NAME
  33 .Nm aio_cancel
  34 .Nd cancel an outstanding asynchronous I/O operation (REALTIME)
  35 .Sh LIBRARY
  36 .Lb librt
  37 .Sh SYNOPSIS
  38 .In aio.h
  39 .Ft int
  40 .Fn aio_cancel "int fildes" "struct aiocb * aiocbp"
  41 .Sh DESCRIPTION
  42 The
  43 .Fn aio_cancel
  44 system call cancels the outstanding asynchronous
  45 I/O request for the file descriptor specified in
  46 .Fa fildes .
  47 If
  48 .Fa aiocbp
  49 is specified, only that specific asynchronous I/O request is cancelled.
  50 .Pp
  51 Normal asynchronous notification occurs for cancelled requests.
  52 Requests complete with an error result of
  53 .Er ECANCELED .
  54 .Sh RESTRICTIONS
  55 The
  56 .Fn aio_cancel
  57 system call does not cancel asynchronous I/O requests for raw disk devices.
  58 The
  59 .Fn aio_cancel
  60 system call will always return
  61 .Dv AIO_NOTCANCELED
  62 for file descriptors associated with raw disk devices.
  63 .Sh RETURN VALUES
  64 The
  65 .Fn aio_cancel
  66 system call returns \-1 to indicate an error, or one of the following:
  67 .Bl -tag -width Dv
  68 .It Bq Dv AIO_CANCELED
  69 All outstanding requests meeting the criteria specified were cancelled.
  70 .It Bq Dv AIO_NOTCANCELED
  71 Some requests were not cancelled, status for the requests should be
  72 checked with
  73 .Xr aio_error 3 .
  74 .It Bq Dv AIO_ALLDONE
  75 All of the requests meeting the criteria have finished.
  76 .El
  77 .Sh ERRORS
  78 An error return from
  79 .Fn aio_cancel
  80 indicates:
  81 .Bl -tag -width Er
  82 .It Bq Er EBADF
  83 The
  84 .Fa fildes
  85 argument is an invalid file descriptor.
  86 .El
  87 .Sh SEE ALSO
  88 .Xr aio_error 3 ,
  89 .Xr aio_read 3 ,
  90 .Xr aio_return 3 ,
  91 .Xr aio_suspend 3 ,
  92 .Xr aio_write 3
  93 .Sh STANDARDS
  94 The
  95 .Fn aio_cancel
  96 system call is expected to conform to the
  97 .St -p1003.1-2001
  98 standard.
  99 .Sh HISTORY
 100 The
 101 .Fn aio_cancel
 102 system call first appeared in
 103 .Nx 5.0 .