DragonFly On-Line Manual Pages

AIO_SUSPEND(3)        DragonFly Library Functions Manual        AIO_SUSPEND(3)

NAME
     aio_suspend -- suspend until asynchronous I/O operations or timeout
     complete (REALTIME)

LIBRARY
     POSIX Real-time Library (librt, -lrt)

SYNOPSIS
     #include <aio.h>

     int
     aio_suspend(const struct aiocb * const iocbs[], int niocb,
         const struct timespec * timeout);

DESCRIPTION
     The aio_suspend() function suspends the calling process until at least
     one of the specified asynchronous I/O requests have completed, a signal
     is delivered, or the timeout has passed.

     iocbs is an array of niocb pointers to asynchronous I/O requests.  Array
     members containing NULL will be silently ignored.

     If timeout is non-NULL, it specifies a maximum interval to suspend.  If
     timeout is a null pointer, the suspend blocks indefinitely.  To effect a
     poll, the timeout should point to a zero-value timespec structure.

RETURN VALUES
     If one or more of the specified asynchronous I/O requests have completed,
     aio_suspend() returns 0.  Otherwise it returns -1 and sets errno to
     indicate the error, as enumerated below.

ERRORS
     The aio_suspend() function will fail if:

     [EAGAIN]           the timeout expired before any I/O requests completed.

     [EINVAL]           iocbs contains more than AIO_LISTIO_MAX asynchronous
                        I/O requests, or at least one of the requests is not
                        valid.

     [EINTR]            the suspend was interrupted by a signal.

SEE ALSO
     aio_cancel(3), aio_error(3), aio_read(3), aio_write(3)

STANDARDS
     aio_suspend() is expected to conform to the IEEE Std 1003.2 (``POSIX.2'')
     standard.

HISTORY
     The aio_suspend function first appeared in FreeBSD 3.0.

AUTHORS
     This manual page was written by Wes Peters <wes@softweyr.com>.

DragonFly 5.5                    June 2, 1999                    DragonFly 5.5