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$
  26 .\"
  27 .Dd January 11, 2021
  28 .Dt AIO_RETURN 2
  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 libc
  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 system call returns the final status of the asynchronous I/O request
  43 associated with the structure pointed to by
  44 .Fa iocb .
  45 .Pp
  46 The
  47 .Fn aio_return
  48 system call
  49 should only be called once, to obtain the final status of an asynchronous
  50 I/O operation once it has completed
  51 .Xr ( aio_error 2
  52 returns something other than
  53 .Er EINPROGRESS ) .
  54 .Sh RETURN VALUES
  55 If the asynchronous I/O request has completed, the status is returned
  56 as described in
  57 .Xr read 2 ,
  58 .Xr readv 2 ,
  59 .Xr write 2 ,
  60 .Xr writev 2 ,
  61 or
  62 .Xr fsync 2 .
  63 Otherwise,
  64 .Fn aio_return
  65 returns \-1 and sets
  66 .Va errno
  67 to indicate the error condition.
  68 .Sh ERRORS
  69 The
  70 .Fn aio_return
  71 system call will fail if:
  72 .Bl -tag -width Er
  73 .It Bq Er EINVAL
  74 The
  75 .Fa iocb
  76 argument
  77 does not reference a completed asynchronous I/O request.
  78 .It Bq Er EINVAL
  79 The I/O operation was submitted with
  80 .Fn lio_listio ,
  81 and the value of the
  82 .Fa aio_lio_opcode
  83 is invalid.
  84 .El
  85 .Sh SEE ALSO
  86 .Xr aio_cancel 2 ,
  87 .Xr aio_error 2 ,
  88 .Xr aio_suspend 2 ,
  89 .Xr aio_waitcomplete 2 ,
  90 .Xr aio_write 2 ,
  91 .Xr fsync 2 ,
  92 .Xr read 2 ,
  93 .Xr write 2 ,
  94 .Xr aio 4
  95 .Sh STANDARDS
  96 The
  97 .Fn aio_return
  98 system call
  99 is expected to conform to the
 100 .St -p1003.1
 101 standard.
 102 .Sh HISTORY
 103 The
 104 .Fn aio_return
 105 system call first appeared in
 106 .Fx 3.0 .
 107 .Sh AUTHORS
 108 This
 109 manual page was written by
 110 .An Wes Peters Aq Mt wes@softweyr.com .