lib/libcr/sys/aio_error.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_error.2,v 1.6.2.6 2001/12/14 18:34:00 ru Exp $
  26 .\"
  27 .Dd June 2, 1999
  28 .Dt AIO_ERROR 2
  29 .Os
  30 .Sh NAME
  31 .Nm aio_error
  32 .Nd retrieve error status of asynchronous I/O operation (REALTIME)
  33 .Sh LIBRARY
  34 .Lb libc
  35 .Sh SYNOPSIS
  36 .In aio.h
  37 .Ft int
  38 .Fn aio_error "const struct aiocb *iocb"
  39 .Sh DESCRIPTION
  40 The
  41 .Fn aio_error
  42 function returns the error status of the asynchronous I/O request
  43 associated with the structure pointed to by
  44 .Fa iocb .
  45 .Sh RETURN VALUES
  46 If the asynchronous I/O request has completed successfully,
  47 .Fn aio_error
  48 returns 0.  If the request has not yet completed,
  49 .Er EINPROGRESS
  50 is returned.  If the request has completed unsuccessfully the error
  51 status is returned as described in
  52 .Xr read 2 ,
  53 .Xr write 2 ,
  54 or
  55 .Xr fsync 2
  56 is returned.
  57 On failure,
  58 .Fn aio_error
  59 returns
  60 .Dv -1
  61 and sets
  62 .Dv errno
  63 to indicate the error condition.
  64 .Sh ERRORS
  65 The
  66 .Fn aio_error
  67 function will fail if:
  68 .Bl -tag -width Er
  69 .It Bq Er EINVAL
  70 .Fa iocb
  71 does not reference an outstanding asynchronous I/O request.
  72 .El
  73 .Sh SEE ALSO
  74 .Xr aio_cancel 2 ,
  75 .Xr aio_read 2 ,
  76 .Xr aio_return 2 ,
  77 .Xr aio_suspend 2 ,
  78 .Xr aio_write 2 ,
  79 .Xr fsync 2 ,
  80 .Xr read 2 ,
  81 .Xr write 2
  82 .Sh STANDARDS
  83 .Fn aio_error
  84 is expected to conform to the
  85 .St -p1003.2
  86 standard.
  87 .Sh HISTORY
  88 The
  89 .Nm
  90 function first appeared in
  91 .Fx 3.0 .
  92 .Sh AUTHORS
  93 This
  94 manual page was written by
  95 .An Wes Peters Aq wes@softweyr.com .