lib/librt/aio_return.3

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