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 .\"     $Id: aio_cancel.2,v 1.3 1999/07/01 21:13:06 mpp Exp $
  26 .\"
  27 .Dd June 2, 1999
  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 SYNOPSIS
  34 .Fd #include <aio.h>
  35 .Ft int
  36 .Fn aio_cancel "int something" "struct aiocb * iocb"
  37 .Sh DESCRIPTION
  38 The
  39 .Fn aio_cancel
  40 function is supposed to cancel the specified outstanding asynchronous
  41 I/O request.
  42 .Fn aio_cancel
  43 is not implemented at this time, and always fails returning
  44 .Dv ENOSYS .
  45 .Sh RETURN VALUES
  46 When
  47 .Fn aio_cancel
  48 inevitably fails, it returns
  49 .Dv ENOSYS
  50 to signify it is not supported.
  51 .Sh SEE ALSO
  52 .Xr aio_error 2 ,
  53 .Xr aio_read 2 ,
  54 .Xr aio_return 2 ,
  55 .Xr aio_suspend 2 ,
  56 .Xr aio_write 2 .
  57 .Sh ERRORS
  58 The
  59 .Fn aio_cancel
  60 function currently always fails, due to:
  61 .Bl -tag -width Er
  62 .It Bq Er ENOSYS
  63 this operation is not implemented at this time.
  64 .El
  65 .Sh STANDARDS
  66 .Nm
  67 fails to conform to the
  68 .St -p1003.2
  69 standard.
  70 .Sh HISTORY
  71 The
  72 .Nm
  73 function first appeared in
  74 .Fx 3.0 .
  75 .Sh AUTHORS
  76 This
  77 manual page was written by
  78 .An Wes Peters Aq wes@softweyr.com .