Content-type: text/html Man page of aio_suspend

aio_suspend

Section: C Library Functions (3)
Index Return to Main Contents
 

NAME

aio_suspend - Suspend the calling process until at least one of the specified asynchronous I/O requests has completed, until a signal interrupts the function, or until a timeout interval, if specified, has passed (P1003.1b)  

SYNOPSIS

#include <aio.h>

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

PARAMETERS

*list
An array of pointers to asynchronous I/O control blocks.
nent
The number of elements in the array. This number specifies the number of asynchronous I/O operations.
*timeout
A pointer to a timespec structure. If timeout is NULL, the argument is ignored.
 

DESCRIPTION

The aio_suspend function suspends the calling process until at least one asynchronous I/O operation has completed, until a signal interrupts the function, or until a timeout interval, if specified, has passed. At the time of the call, if an asynchronous I/O operation specified in the aiocbp array corresponds to completed asynchronous I/O operations, the function returns without suspending the calling process.

The list argument is an array of pointers to aiocb data structures. The nent argument indicates the number of elements in the array. Each aiocbp structure must have been used in initiating an asynchronous I/O request by a call to the aio_read, aio_write, or lio_listio functions.  

RETURN VALUES

If the aio_suspend function returns due to an asynchronous I/O completion, a value of 0 is returned. The application may determine which asynchronous I/O operations finished by calling the aio_error and aio_return functions.

On an unsuccessful call, a value of -1 is returned and errno is set to indicate that an error occurred.  

ERRORS

The aio_suspend function fails under the following conditions:

[EAGAIN]
No asynchronous I/O operation 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 invoke a signal when it completes, this error return may be caused by the completion of one (or more) of the I/O operations being awaited.
[EIVAL]
An invalid time value was specified in timeout, or nent is greater than the maximum number of list elements allowed, AIO_LISTIO_MAX.
 

RELATED INFORMATION

Functions: aio_group_completion_np(3), aio_read(3), aio_results_np(3), aio_write(3), lio_listio(3). delim off


 

Index

NAME
SYNOPSIS
PARAMETERS
DESCRIPTION
RETURN VALUES
ERRORS
RELATED INFORMATION

This document was created by man2html, using the manual pages.
Time: 02:42:09 GMT, October 02, 2010