lib/libcr/sys/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.8.2.5 2001/12/14 18:34:00 ru Exp $
  26 .\" $DragonFly: src/lib/libcr/sys/Attic/aio_suspend.2,v 1.2 2003/06/17 04:26:47 dillon Exp $
  27 .\"
  28 .Dd June 2, 1999
  29 .Dt AIO_SUSPEND 2
  30 .Os
  31 .Sh NAME
  32 .Nm aio_suspend
  33 .Nd suspend until asynchronous I/O operations or timeout complete (REALTIME)
  34 .Sh LIBRARY
  35 .Lb libc
  36 .Sh SYNOPSIS
  37 .In aio.h
  38 .Ft int
  39 .Fn aio_suspend "const struct aiocb * const iocbs[]" "int niocb" "const struct timespec * timeout"
  40 .Sh DESCRIPTION
  41 The
  42 .Fn aio_suspend
  43 function suspends the calling process until at least one of the
  44 specified asynchronous I/O requests have completed, a signal is
  45 delivered, or the
  46 .Fa timeout
  47 has passed.
  48 .Pp
  49 .Fa iocbs
  50 is an array of
  51 .Fa niocb
  52 pointers to asynchronous I/O requests.  Array members containing
  53 NULL will be silently ignored.
  54 .Pp
  55 If
  56 .Fa timeout
  57 is a non-nil pointer, it specifies a maximum interval to suspend.
  58 If
  59 .Fa timeout
  60 is a nil pointer, the suspend blocks indefinitely.  To effect a
  61 poll, the
  62 .Fa timeout
  63 should point to a zero-value timespec structure.
  64 .Sh RETURN VALUES
  65 If one or more of the specified asynchronous I/O requests have
  66 completed,
  67 .Fn aio_suspend
  68 returns 0.  Otherwise it returns -1 and sets
  69 .Va errno
  70 to indicate the error, as enumerated below.
  71 .Sh SEE ALSO
  72 .Xr aio_cancel 2 ,
  73 .Xr aio_error 2 ,
  74 .Xr aio_read 2 ,
  75 .Xr aio_suspend 2 ,
  76 .Xr aio_write 2
  77 .Sh ERRORS
  78 The
  79 .Fn aio_suspend
  80 function will fail if:
  81 .Bl -tag -width Er
  82 .It Bq Er EAGAIN
  83 the
  84 .Fa timeout
  85 expired before any I/O requests completed.
  86 .It Bq Er EINVAL
  87 .Fa iocbs
  88 contains more than
  89 .Dv AIO_LISTIO_MAX
  90 asynchronous I/O requests, or at least one of the requests is not
  91 valid.
  92 .It Bq Er EINTR
  93 the suspend was interrupted by a signal.
  94 .El
  95 .Sh STANDARDS
  96 .Fn aio_suspend
  97 is expected to conform to the
  98 .St -p1003.2
  99 standard.
 100 .Sh HISTORY
 101 The
 102 .Nm
 103 function first appeared in
 104 .Fx 3.0 .
 105 .Sh AUTHORS
 106 This
 107 manual page was written by
 108 .An Wes Peters Aq wes@softweyr.com .