Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

aio_suspend(3) [opendarwin man page]

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

aio_suspend - wait for asynchronous I/O operation or timeout SYNOPSIS
#include <aio.h> int aio_suspend(const struct aiocb * const aiocb_list[], int nitems, const struct timespec *timeout); Link with -lrt. DESCRIPTION
The aio_suspend() function suspends the calling thread until one of the following occurs: * One or more of the asynchronous I/O requests in the list aiocb_list has completed. * A signal is delivered. * timeout is not NULL and the specified time interval has passed. (For details of the timespec structure, see nanosleep(2).) The nitems argument specifies the number of items in aiocb_list. Each item in the list pointed to by aiocb_list must be either NULL (and then is ignored), or a pointer to a control block on which I/O was initiated using aio_read(3), aio_write(3), or lio_listio(3). (See aio(7) for a description of the aiocb structure.) If CLOCK_MONOTONIC is supported, this clock is used to measure the timeout interval (see clock_gettime(3)). RETURN VALUE
If this function returns after completion of one of the I/O requests specified in aiocb_list, 0 is returned. Otherwise, -1 is returned, and errno is set to indicate the error. ERRORS
EAGAIN The call timed out before any of the indicated operations had completed. EINTR The call was ended by signal (possibly the completion signal of one of the operations we were waiting for); see signal(7). ENOSYS aio_suspend() is not implemented. VERSIONS
The aio_suspend() 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_suspend() | Thread safety | MT-Safe | +--------------+---------------+---------+ CONFORMING TO
POSIX.1-2001, POSIX.1-2008. NOTES
One can achieve polling by using a non-NULL timeout that specifies a zero time interval. If one or more of the asynchronous I/O operations specified in aiocb_list has already completed at the time of the call to aio_suspend(), then the call returns immediately. To determine which I/O operations have completed after a successful return from aio_suspend(), use aio_error(3) to scan the list of aiocb structures pointed to by aiocb_list. BUGS
The glibc implementation of aio_suspend() is not async-signal-safe, in violation of the requirements of POSIX.1. SEE ALSO
aio_cancel(3), aio_error(3), aio_fsync(3), aio_read(3), aio_return(3), aio_write(3), lio_listio(3), aio(7), time(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 2017-09-15 AIO_SUSPEND(3)

Check Out this Related Man Page

aio_suspend(3C) 					   Standard C Library Functions 					   aio_suspend(3C)

aio_suspend - wait for asynchronous I/O request 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 argu- ment 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 argu- ment is an array of pointers to asynchronous I/O control blocks. The nent argument indicates the number of elements in the array and is limited to _AIO_LISTIO_MAX = 4096. Each aiocb structure pointed to will have been used in initiating an asynchronous I/O request via aio_read(3C), aio_write(3C), or lio_listio(3C). 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 VALUES
If aio_suspend() returns after one or more asynchronous I/O operations have completed, it returns 0. Otherwise, it returns -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(3C) and aio_return(3C), 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. Since each asynchronous I/O operation might provoke a signal when it completes, this error return can be caused by the completion of one or more of the very I/O operations being awaited. EINVAL The nent argument is less than or equal to 0 or greater than _AIO_LISTIO_MAX, or the timespec structure pointed to by timeout is not properly set because tv_sec is less than 0 or tv_nsec is either less than 0 or greater than 10^9. ENOMEM There is currently not enough available memory; the application can try again later. ENOSYS The aio_suspend() function is not supported by the system. USAGE
The aio_suspend() function has a transitional interface for 64-bit file offsets. See lf64(5). ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |Interface Stability |Committed | +-----------------------------+-----------------------------+ |MT-Level |Async-Signal-Safe | +-----------------------------+-----------------------------+ |Standard |See standards(5). | +-----------------------------+-----------------------------+ SEE ALSO
aio.h(3HEAD), aio_fsync(3C), aio_read(3C), aio_return(3C), aio_write(3C), lio_listio(3C), signal.h(3HEAD), attributes(5), lf64(5), stan- dards(5) NOTES
Solaris 2.6 was the first release to support the Asynchronous Input and Output option. Prior to this release, this function always returned -1 and set errno to ENOSYS. SunOS 5.11 18 Dec 2008 aio_suspend(3C)
Man Page