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: head/lib/libc/sys/aio_suspend.2 105864 2002-10-24 12:57:05Z sheldonh $
|
| 25.\" $FreeBSD: head/lib/libc/sys/aio_suspend.2 108028 2002-12-18 09:22:32Z ru $ |
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
|
42function suspends the calling process until at least one of the
|
| 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
48.Fa iocbs
49is an array of
50.Fa niocb
51pointers to asynchronous I/O requests. Array members containing
52NULL will be silently ignored.
53.Pp
54If
55.Fa timeout
56is a non-nil pointer, it specifies a maximum interval to suspend.
57If
58.Fa timeout
59is a nil pointer, the suspend blocks indefinitely. To effect a
60poll, the
61.Fa timeout
62should point to a zero-value timespec structure.
63.Sh RETURN VALUES
64If one or more of the specified asynchronous I/O requests have
65completed,
66.Fn aio_suspend
67returns 0. Otherwise it returns -1 and sets
68.Va errno
69to indicate the error, as enumerated below.
70.Sh ERRORS
71The
72.Fn aio_suspend
|
73function will fail if:
|
| 73system call will fail if: |
74.Bl -tag -width Er
75.It Bq Er EAGAIN
76the
77.Fa timeout
78expired before any I/O requests completed.
79.It Bq Er EINVAL
80.Fa iocbs
81contains more than
82.Dv AIO_LISTIO_MAX
83asynchronous I/O requests, or at least one of the requests is not
84valid.
85.It Bq Er EINTR
86the suspend was interrupted by a signal.
87.El
88.Sh SEE ALSO
89.Xr aio_cancel 2 ,
90.Xr aio_error 2 ,
91.Xr aio_return 2 ,
92.Xr aio_waitcomplete 2 ,
93.Xr aio_write 2 ,
94.Xr aio 4
95.Sh STANDARDS
|
| 96The |
97.Fn aio_suspend
|
| 98system call |
99is expected to conform to the
100.St -p1003.2
101standard.
102.Sh HISTORY
103The
|
102.Nm
103function first appeared in
|
104.Fn aio_suspend
105system call first appeared in |
106.Fx 3.0 .
107.Sh AUTHORS
108This
109manual page was written by
110.An Wes Peters Aq wes@softweyr.com .
|