Section (3) aio_return


Linux manual pages Section 3  

Name

aio_return — get return status of asynchronous I/O operation

Synopsis

#include <aio.h>
ssize_t aio_return( struct aiocb *aiocbp);
 
[Note] Note

Link with −lrt.

DESCRIPTION

The aio_return() function returns the final return status for the asynchronous I/O request with control block pointed to by aiocbp. (See aio(7) for a description of the aiocb structure.)

This function should be called only once for any given request, after aio_error(3) returns something other than EINPROGRESS.

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 read(2), write(2), fsync(2) or fdatasync(2), call. On error, −1 is returned, and errno is set appropriately.

If the asynchronous I/O operation has not yet completed, the return value and effect of aio_return() are undefined.

ERRORS

EINVAL

aiocbp does not point at a control block for an asynchronous I/O request of which the return status has not been retrieved yet.

ENOSYS

aio_return() is not implemented.

VERSIONS

The aio_return() function is available since glibc 2.1.

ATTRIBUTES

For an explanation of the terms used in this section, see attributes(7).

Interface Attribute Value
aio_return() Thread safety MT-Safe

CONFORMING TO

POSIX.1-2001, POSIX.1-2008.

EXAMPLE

See aio(7).

SEE ALSO

aio_cancel(3), aio_error(3), aio_fsync(3), aio_read(3), aio_suspend(3), aio_write(3), lio_listio(3), aio(7)

COLOPHON

This page is part of release 4.16 of the Linux man-pages project. A description of the project, information about reporting bugs, and the latest version of this page, can be found at https://www.kernel.org/doc/man−pages/.


  Copyright (c) 2003 Andries Brouwer (aebcwi.nl)

%%%LICENSE_START(GPLv2+_DOC_FULL)
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_zsingle_quotesz_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, see
<http://www.gnu.org/licenses/>.
%%%LICENSE_END