original/man3/aio_return.3

   1 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
   2 .\"
   3 .\" This is free documentation; you can redistribute it and/or
   4 .\" modify it under the terms of the GNU General Public License as
   5 .\" published by the Free Software Foundation; either version 2 of
   6 .\" the License, or (at your option) any later version.
   7 .\"
   8 .\" The GNU General Public License's references to "object code"
   9 .\" and "executables" are to be interpreted as the output of any
  10 .\" document formatting or typesetting system, including
  11 .\" intermediate and printed output.
  12 .\"
  13 .\" This manual is distributed in the hope that it will be useful,
  14 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  15 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16 .\" GNU General Public License for more details.
  17 .\"
  18 .\" You should have received a copy of the GNU General Public
  19 .\" License along with this manual; if not, write to the Free
  20 .\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
  21 .\" USA.
  22 .\"
  23 .TH AIO_RETURN 3 2010-10-03  "" "Linux Programmer's Manual"
  24 .SH NAME
  25 aio_return \- get return status of asynchronous I/O operation
  26 .SH SYNOPSIS
  27 .B "#include <aio.h>"
  28 .sp
  29 .BI "ssize_t aio_return(struct aiocb *" aiocbp );
  30 .sp
  31 Link with \fI\-lrt\fP.
  32 .SH DESCRIPTION
  33 The
  34 .BR aio_return ()
  35 function returns the final return status for the asynchronous I/O request
  36 with control block pointed to by
  37 .IR aiocbp .
  38 (See
  39 .BR aio (7)
  40 for a description of the
  41 .I aiocb
  42 structure.)
  43 .LP
  44 This function should be called only once for any given request, after
  45 .BR aio_error (3)
  46 returns something other than
  47 .BR EINPROGRESS .
  48 .SH "RETURN VALUE"
  49 If the asynchronous I/O operation has completed, this function returns
  50 the value that would have been returned in case of a synchronous
  51 .BR read (2),
  52 .BR write (2),
  53 .BR fsync (2)
  54 or
  55 .BR fdatasync (2),
  56 call.
  57
  58 If the asynchronous I/O operation has not yet completed,
  59 the return value and effect of
  60 .BR aio_return ()
  61 are undefined.
  62 .SH ERRORS
  63 .TP
  64 .B EINVAL
  65 .I aiocbp
  66 does not point at a control block for an asynchronous I/O request
  67 of which the return status has not been retrieved yet.
  68 .SH VERSIONS
  69 The
  70 .BR aio_return ()
  71 function is available since glibc 2.1.
  72 .SH "CONFORMING TO"
  73 POSIX.1-2001, POSIX.1-2008.
  74 .SH EXAMPLE
  75 See
  76 .BR aio (7).
  77 .SH "SEE ALSO"
  78 .BR aio_cancel (3),
  79 .BR aio_error (3),
  80 .BR aio_fsync (3),
  81 .BR aio_read (3),
  82 .BR aio_suspend (3),
  83 .BR aio_write (3),
  84 .BR lio_listio (3),
  85 .BR aio (7)