1.\" Copyright (c) 1999 Softweyr LLC. 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY Softweyr LLC AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL Softweyr LLC OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd June 2, 1999 28.Dt AIO_SUSPEND 2 29.Os 30.Sh NAME 31.Nm aio_suspend 32.Nd suspend until asynchronous I/O operations or timeout complete (REALTIME) 33.Sh LIBRARY 34.Lb libc 35.Sh SYNOPSIS 36.In aio.h 37.Ft int 38.Fn aio_suspend "const struct aiocb *const iocbs[]" "int niocb" "const struct timespec *timeout" 39.Sh DESCRIPTION 40The 41.Fn aio_suspend 42system call suspends the calling process until at least one of the 43specified asynchronous I/O requests have completed, a signal is 44delivered, or the 45.Fa timeout 46has passed. 47.Pp 48The 49.Fa iocbs 50argument 51is an array of 52.Fa niocb 53pointers to asynchronous I/O requests. 54Array members containing 55null pointers will be silently ignored. 56.Pp 57If 58.Fa timeout 59is not a null pointer, it specifies a maximum interval to suspend. 60If 61.Fa timeout 62is a null pointer, the suspend blocks indefinitely. 63To effect a 64poll, the 65.Fa timeout 66should point to a zero-value timespec structure. 67.Sh RETURN VALUES 68If one or more of the specified asynchronous I/O requests have 69completed, 70.Fn aio_suspend 71returns 0. 72Otherwise it returns -1 and sets 73.Va errno 74to indicate the error, as enumerated below. 75.Sh ERRORS 76The 77.Fn aio_suspend 78system call will fail if: 79.Bl -tag -width Er 80.It Bq Er EAGAIN 81the 82.Fa timeout 83expired before any I/O requests completed. 84.It Bq Er EINVAL 85The 86.Fa iocbs 87argument 88contains more than 89.Dv AIO_LISTIO_MAX 90asynchronous I/O requests, or at least one of the requests is not 91valid. 92.It Bq Er EINTR 93the suspend was interrupted by a signal. 94.El 95.Sh SEE ALSO 96.Xr aio_cancel 2 , 97.Xr aio_error 2 , 98.Xr aio_return 2 , 99.Xr aio_waitcomplete 2 , 100.Xr aio_write 2 , 101.Xr aio 4 102.Sh STANDARDS 103The 104.Fn aio_suspend 105system call 106is expected to conform to the 107.St -p1003.1 108standard. 109.Sh HISTORY 110The 111.Fn aio_suspend 112system call first appeared in 113.Fx 3.0 . 114.Sh AUTHORS 115This 116manual page was written by 117.An Wes Peters Aq Mt wes@softweyr.com . 118