NAME

aio_suspend - wait for an asynchronous I/O request (REALTIME)

 SYNOPSIS

#include <aio.h>

int aio_suspend(const struct aiocb * const list[], int nent,
    const struct timespec *timeout);

 DESCRIPTION

The aio_suspend() function suspends the calling thread until at least one of the asynchronous I/O operations referenced by the list argument has completed, until a signal interrupts the function, or, if timeout is not NULL, until the time interval specified by timeout has passed. If any of the aiocb structures in the list correspond to completed asynchronous I/O operations (that is, the error status for the operation is not equal to EINPROGRESS) at the time of the call, the function returns without suspending the calling thread The list argument is an array of pointers to asynchronous I/O control blocks. The nent argument indicates the number of elements in the array. Each aiocb structure pointed to will have been used in initiating an asynchronous I/O request via aio_read(), aio_write(), or lio_listio(). This array may contain NULL pointers, which are ignored. If this array contains pointers that refer to aiocb structures that have not been used in submitting asynchronous I/O, the effect is undefined.

If the time interval indicated in the timespec structure pointed to by timeout passes before any of the I/O operations referenced by list are completed, then aio_suspend() returns with an error.

 RETURN VALUE

If the aio_suspend() function returns after one or more asynchronous I/O operations have completed, the function returns zero. Otherwise, the function returns a value of -1 and sets errno to indicate the error.

The application may determine which asynchronous I/O completed by scanning the associated error and return status using aio_error() and aio_return(), respectively.

 ERRORS

The aio_suspend() function will fail if:

[EAGAIN]

No asynchronous I/O indicated in the list referenced by list completed in the time interval indicated by timeout.

[EINTR]

A signal interrupted the aio_suspend() function. Note that, since each asynchronous I/O operation may possibly provoke a signal when it completes, this error return may be caused by the completion of one (or more) of the very I/O operations being awaited.

[ENOSYS]

The aio_suspend() function is not supported by this implementation.

 EXAMPLES

None.

 APPLICATION USAGE

None.

 FUTURE DIRECTIONS

None.

 SEE ALSO

aio_read(), aio_write(), lio_listio().

DERIVATION

Derived from the POSIX Realtime Extension (1003.1b-1993/1003.1i-1995)