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