AIO_READ



AIO_READ

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUE
ERRORS
VERSIONS
CONFORMING TO
NOTES
EXAMPLE
SEE ALSO
COLOPHON

NAME

aio_read − asynchronous read

SYNOPSIS

#include <aio.h>

int aio_read(struct aiocb *aiocbp);

Link with −lrt.

DESCRIPTION

The aio_read() function queues the I/O request described by the buffer pointed to by aiocbp. This function is the asynchronous analog of read(2). The arguments of the call

read(fd, buf, count)

correspond (in order) to the fields aio_fildes, aio_buf, and aio_nbytes of the structure pointed to by aiocbp. (See aio(7) for a description of the aiocb structure.)

The data is read starting at the absolute file offset aiocbp−>aio_offset, regardless of the current file offset. After the call, the value of the current file offset is unspecified.

The "asynchronous" means that this call returns as soon as the request has been enqueued; the read may or may not have completed when the call returns. One tests for completion using aio_error(3). The return status of a completed I/O operation can be obtained by aio_return(3). Asynchronous notification of I/O completion can be obtained by setting aiocbp−>aio_sigevent appropriately; see sigevent(7) for details.

If _POSIX_PRIORITIZED_IO is defined, and this file supports it, then the asynchronous operation is submitted at a priority equal to that of the calling process minus aiocbp−>aio_reqprio.

The field aiocbp−>aio_lio_opcode is ignored.

No data is read from a regular file beyond its maximum offset.

RETURN VALUE

On success, 0 is returned. On error, the request is not enqueued, −1 is returned, and errno is set appropriately. If an error is detected only later, it will be reported via aio_return(3) (returns status −1) and aio_error(3) (error status—whatever one would have gotten in errno, such as EBADF).

ERRORS

EAGAIN

Out of resources.

EBADF

aio_fildes is not a valid file descriptor open for reading.

EINVAL

One or more of aio_offset, aio_reqprio, or aio_nbytes are invalid.

ENOSYS

aio_read() is not implemented.

EOVERFLOW

The file is a regular file, we start reading before end-of-file and want at least one byte, but the starting position is past the maximum offset for this file.

VERSIONS

The aio_read() function is available since glibc 2.1.

CONFORMING TO

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

NOTES

It is a good idea to zero out the control block before use. The control block must not be changed while the read operation is in progress. The buffer area being read into must not be accessed during the operation or undefined results may occur. The memory areas involved must remain valid.

Simultaneous I/O operations specifying the same aiocb structure produce undefined results.

EXAMPLE

See aio(7).

SEE ALSO

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

COLOPHON

This page is part of release 3.69 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 http://www.kernel.org/doc/man−pages/.







Opportunity


Personal Opportunity - Free software gives you access to billions of dollars of software at no cost. Use this software for your business, personal use or to develop a profitable skill. Access to source code provides access to a level of capabilities/information that companies protect though copyrights. Open source is a core component of the Internet and it is available to you. Leverage the billions of dollars in resources and capabilities to build a career, establish a business or change the world. The potential is endless for those who understand the opportunity.

Business Opportunity - Goldman Sachs, IBM and countless large corporations are leveraging open source to reduce costs, develop products and increase their bottom lines. Learn what these companies know about open source and how open source can give you the advantage.





Free Software


Free Software provides computer programs and capabilities at no cost but more importantly, it provides the freedom to run, edit, contribute to, and share the software. The importance of free software is a matter of access, not price. Software at no cost is a benefit but ownership rights to the software and source code is far more significant.


Free Office Software - The Libre Office suite provides top desktop productivity tools for free. This includes, a word processor, spreadsheet, presentation engine, drawing and flowcharting, database and math applications. Libre Office is available for Linux or Windows.





Free Books


The Free Books Library is a collection of thousands of the most popular public domain books in an online readable format. The collection includes great classical literature and more recent works where the U.S. copyright has expired. These books are yours to read and use without restrictions.


Source Code - Want to change a program or know how it works? Open Source provides the source code for its programs so that anyone can use, modify or learn how to write those programs themselves. Visit the GNU source code repositories to download the source.





Education


Study at Harvard, Stanford or MIT - Open edX provides free online courses from Harvard, MIT, Columbia, UC Berkeley and other top Universities. Hundreds of courses for almost all major subjects and course levels. Open edx also offers some paid courses and selected certifications.


Linux Manual Pages - A man or manual page is a form of software documentation found on Linux/Unix operating systems. Topics covered include computer programs (including library and system calls), formal standards and conventions, and even abstract concepts.