2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
|
|
|
|
|
.\"
|
|
|
|
|
.\" This is free documentation; you can redistribute it and/or
|
|
|
|
|
.\" modify it under the terms of the GNU General Public License as
|
|
|
|
|
.\" published by the Free Software Foundation; either version 2 of
|
|
|
|
|
.\" the License, or (at your option) any later version.
|
|
|
|
|
.\"
|
|
|
|
|
.\" The GNU General Public License's references to "object code"
|
|
|
|
|
.\" and "executables" are to be interpreted as the output of any
|
|
|
|
|
.\" document formatting or typesetting system, including
|
|
|
|
|
.\" intermediate and printed output.
|
|
|
|
|
.\"
|
|
|
|
|
.\" This manual is distributed in the hope that it will be useful,
|
|
|
|
|
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
.\" GNU General Public License for more details.
|
|
|
|
|
.\"
|
|
|
|
|
.\" You should have received a copy of the GNU General Public
|
|
|
|
|
.\" License along with this manual; if not, write to the Free
|
|
|
|
|
.\" Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111,
|
|
|
|
|
.\" USA.
|
|
|
|
|
.\"
|
2010-10-03 05:19:04 +00:00
|
|
|
.TH AIO_RETURN 3 2010-10-03 "" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
|
aio_return \- get return status of asynchronous I/O operation
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
.B "#include <aio.h>"
|
|
|
|
|
.sp
|
|
|
|
|
.BI "ssize_t aio_return(struct aiocb *" aiocbp );
|
2008-04-25 06:35:53 +00:00
|
|
|
.sp
|
|
|
|
|
Link with \fI\-lrt\fP.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The
|
2005-10-19 06:54:38 +00:00
|
|
|
.BR aio_return ()
|
2004-11-03 13:51:07 +00:00
|
|
|
function returns the final return status for the asynchronous I/O request
|
|
|
|
|
with control block pointed to by
|
|
|
|
|
.IR aiocbp .
|
2010-10-02 13:27:41 +00:00
|
|
|
(See
|
|
|
|
|
.BR aio (7)
|
|
|
|
|
for a description of the
|
|
|
|
|
.I aiocb
|
|
|
|
|
structure.)
|
2004-11-03 13:51:07 +00:00
|
|
|
.LP
|
|
|
|
|
This function should be called only once for any given request, after
|
2004-12-20 10:14:48 +00:00
|
|
|
.BR aio_error (3)
|
2007-06-22 19:42:52 +00:00
|
|
|
returns something other than
|
|
|
|
|
.BR EINPROGRESS .
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "RETURN VALUE"
|
|
|
|
|
If the asynchronous I/O operation has completed, this function returns
|
|
|
|
|
the value that would have been returned in case of a synchronous
|
2010-10-02 13:51:35 +00:00
|
|
|
.BR read (2),
|
|
|
|
|
.BR write (2),
|
|
|
|
|
.BR fsync (2)
|
2004-11-03 13:51:07 +00:00
|
|
|
or
|
2010-10-02 13:51:35 +00:00
|
|
|
.BR fdatasync (2),
|
|
|
|
|
call.
|
|
|
|
|
|
|
|
|
|
If the asynchronous I/O operation has not yet completed,
|
|
|
|
|
the return value and effect of
|
|
|
|
|
.BR aio_return ()
|
|
|
|
|
are undefined.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH ERRORS
|
|
|
|
|
.TP
|
|
|
|
|
.B EINVAL
|
|
|
|
|
.I aiocbp
|
|
|
|
|
does not point at a control block for an asynchronous I/O request
|
|
|
|
|
of which the return status has not been retrieved yet.
|
2010-10-02 12:35:28 +00:00
|
|
|
.SH VERSIONS
|
|
|
|
|
The
|
|
|
|
|
.BR aio_return ()
|
|
|
|
|
function is available since glibc 2.1.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2010-10-02 12:35:28 +00:00
|
|
|
POSIX.1-2001, POSIX.1-2008.
|
2010-10-03 05:19:04 +00:00
|
|
|
.SH EXAMPLE
|
|
|
|
|
See
|
|
|
|
|
.BR aio (7).
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
|
.BR aio_cancel (3),
|
|
|
|
|
.BR aio_error (3),
|
|
|
|
|
.BR aio_fsync (3),
|
|
|
|
|
.BR aio_read (3),
|
|
|
|
|
.BR aio_suspend (3),
|
2010-10-02 13:16:38 +00:00
|
|
|
.BR aio_write (3),
|
|
|
|
|
.BR aio (7)
|
