bsd/man/man2/aio_suspend.2

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