Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

aio_return(3p) [suse man page]

AIO_RETURN(3P)						     POSIX Programmer's Manual						    AIO_RETURN(3P)

PROLOG
This manual page is part of the POSIX Programmer's Manual. The Linux implementation of this interface may differ (consult the correspond- ing Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux. NAME
aio_return - retrieve return status of an asynchronous I/O operation (REALTIME) SYNOPSIS
#include <aio.h> ssize_t aio_return(struct aiocb *aiocbp); DESCRIPTION
The aio_return() function shall return the return status associated with the aiocb structure referenced by the aiocbp argument. The return status for an asynchronous I/O operation is the value that would be returned by the corresponding read(), write(), or fsync() function call. If the error status for the operation is equal to [EINPROGRESS], then the return status for the operation is undefined. The aio_return() function may be called exactly once to retrieve the return status of a given asynchronous operation; thereafter, if the same aiocb structure is used in a call to aio_return() or aio_error(), an error may be returned. When the aiocb structure referred to by aiocbp is used to submit another asynchronous operation, then aio_return() may be successfully used to retrieve the return status of that opera- tion. RETURN VALUE
If the asynchronous I/O operation has completed, then the return status, as described for read(), write(), and fsync(), shall be returned. If the asynchronous I/O operation has not yet completed, the results of aio_return() are undefined. ERRORS
The aio_return() function may fail if: EINVAL The aiocbp argument does not refer to an asynchronous operation whose return status has not yet been retrieved. The following sections are informative. EXAMPLES
None. APPLICATION USAGE
The aio_return() function is part of the Asynchronous Input and Output option and need not be available on all implementations. RATIONALE
None. FUTURE DIRECTIONS
None. SEE ALSO
aio_cancel(), aio_error(), aio_fsync(), aio_read(), aio_write(), close(), exec(), exit(), fork(), lio_listio(), lseek(), read() , the Base Definitions volume of IEEE Std 1003.1-2001, <aio.h> COPYRIGHT
Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technol- ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html . IEEE
/The Open Group 2003 AIO_RETURN(3P)

Check Out this Related Man Page

AIO_RETURN(3)                                                Linux Programmer's Manual                                               AIO_RETURN(3)

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). 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.15 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/. 2017-09-15 AIO_RETURN(3)
Man Page