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