www.LinuxHowtos.org

AIO_RETURN

Section: Linux Programmer's Manual (3)
Updated: 2017-09-15
Index Return to Main Contents

NAME

aio_return - get return status of asynchronous I/O operation

SYNOPSIS

#include <aio.h>

ssize_t aio_return(struct aiocb *aiocbp);

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).

COLOPHON

This page is part of release 4.13 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/.