aio_read(2)

DESCRIPTION

The aio_read() function allows the calling process to perform an asynchronous read from a previously opened file. The function call returns when the read operation has been enqueued for processing. Once enqueued, processing of the read operation may proceed concurrently with execution of the calling process thread.

If an error condition is detected that prevents the read request from being enqueued, aio_read() returns -1 and sets errno to indicate the cause of the failure. Once the read operation has been successfully enqueued, an aio_error() and aio_return() function referencing the aiocb referred to by aiocbp must be used to determine its status and any error conditions, including those normally reported by read(). The request remains enqueued and consumes process and system resources until aio_return() is called.

The aio_read() function allows the calling process to read aiocbp->aio_nbytes from the file associated with aiocbp->aio_fildes into the buffer pointed to by aiocbp->aio_buf. The priority of the read operation is reduced by the value of aiocbp->aio_reqprio, which must be a value between 0 (zero) and a maximum value which can be obtained using the sysconf() call with the argument _SC_AIO_PRIO_DELTA_MAX. A value of 0 (zero) yields no reduction in priority. The aiocbp->aio_lio_opcode field is ignored.

The read operation takes place at the absolute position in the file given by aiocbp->aio_offset, as if lseek() were called immediately prior to the operation with offset equal to aiocbp->aio_offset and whence set to SEEK_SET. However, the value of the file offset is never changed by asynchronous I/O operations.

Altering the contents of or deallocating memory associated with the aiocb referred to by aiocbp or the buffer referred to by aiocbp->aio_buf while an asynchronous read operation is outstanding may produce unpredictable results because aio_return() has not been called for the aiocb.

If aiocbp->aio_sigevent is a valid signal event structure, then the designated signal will be delivered when the requested asynchronous read operation completes.

To use this function, link in the realtime library by specifying -lrt on the compiler or linker command line.

RETURN VALUE

aio_read() returns the following values:

The return value from aio_read() reflects the success or failure of enqueuing the requested read operation for asynchronous processing. aio_read() fails if an error in the function call is immediately detected, or if system resource limits prevent the request from being enqueued. Other error conditions are reported asynchronously and must be retrieved with aio_error() and aio_return().

ERRORS

If aio_read() detects one of the following error conditions, errno is set to the indicated value:

Once the read request has been enqueued by aio_read(), all of the errors normally reported by the read() function and the following errors may be reported asynchronously and returned in a subsequent call to aio_error() or aio_return() referencing the aiocb supplied in the successful aio_read() call.

EXAMPLE

The following code sequence and call to aio_read() starts an asynchronous read operation.

SEE ALSO

aio_cancel(2), aio_error(2), aio_fsync(2), aio_return(2), aio_suspend(2), aio_write(2), lio_listio(2), read(2), aio(5).

STANDARDS CONFORMANCE

aio_read(): POSIX Realtime Extensions, IEEE Std 1003.1b