original/man3/aio_suspend.3

   1 .\" Copyright (c) 2003 Andries Brouwer (aeb@cwi.nl)
   2 .\" and Copyright (C) 2010 Michael kerrisk <mtk.manpages@gmail.com>
   3 .\"
   4 .\" %%%LICENSE_START(GPLv2+_DOC_FULL)
   5 .\" This is free documentation; you can redistribute it and/or
   6 .\" modify it under the terms of the GNU General Public License as
   7 .\" published by the Free Software Foundation; either version 2 of
   8 .\" the License, or (at your option) any later version.
   9 .\"
  10 .\" The GNU General Public License's references to "object code"
  11 .\" and "executables" are to be interpreted as the output of any
  12 .\" document formatting or typesetting system, including
  13 .\" intermediate and printed output.
  14 .\"
  15 .\" This manual is distributed in the hope that it will be useful,
  16 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  17 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18 .\" GNU General Public License for more details.
  19 .\"
  20 .\" You should have received a copy of the GNU General Public
  21 .\" License along with this manual; if not, see
  22 .\" <http://www.gnu.org/licenses/>.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .TH AIO_SUSPEND 3 2012-05-08  "" "Linux Programmer's Manual"
  26 .SH NAME
  27 aio_suspend \- wait for asynchronous I/O operation or timeout
  28 .SH SYNOPSIS
  29 .nf
  30 .sp
  31 .B "#include <aio.h>"
  32 .sp
  33 .BI "int aio_suspend(const struct aiocb * const " aiocb_list [],
  34 .br
  35 .BI "                int " nitems ", const struct timespec *" timeout );
  36 .sp
  37 Link with \fI\-lrt\fP.
  38 .fi
  39 .SH DESCRIPTION
  40 The
  41 .BR aio_suspend ()
  42 function suspends the calling thread until one of the following occurs:
  43 .IP * 3
  44 One or more of the asynchronous I/O requests in the list
  45 .I aiocb_list
  46 has completed.
  47 .IP *
  48 A signal is delivered.
  49 .IP *
  50 .I timeout
  51 is not NULL and the specified time interval has passed.
  52 (For details of the
  53 .I timespec
  54 structure, see
  55 .BR nanosleep (2).)
  56 .LP
  57 The
  58 .I nitems
  59 argument specifies the number of items in
  60 .IR aiocb_list .
  61 Each item in the list pointed to by
  62 .I aiocb_list
  63 must be either NULL (and then is ignored),
  64 or a pointer to a control block on which I/O was initiated using
  65 .BR aio_read (3),
  66 .BR aio_write (3),
  67 or
  68 .BR lio_listio (3).
  69 (See
  70 .BR aio (7)
  71 for a description of the
  72 .I aiocb
  73 structure.)
  74 .LP
  75 If
  76 .B CLOCK_MONOTONIC
  77 is supported, this clock is used to measure
  78 the timeout interval (see
  79 .BR clock_gettime (3)).
  80 .SH RETURN VALUE
  81 If this function returns after completion of one of the I/O
  82 requests specified in
  83 .IR aiocb_list ,
  84 0 is returned.
  85 Otherwise, \-1 is returned, and
  86 .I errno
  87 is set to indicate the error.
  88 .SH ERRORS
  89 .TP
  90 .B EAGAIN
  91 The call timed out before any of the indicated operations
  92 had completed.
  93 .TP
  94 .B EINTR
  95 The call was ended by signal
  96 (possibly the completion signal of one of the operations we were
  97 waiting for); see
  98 .BR signal (7).
  99 .TP
 100 .B ENOSYS
 101 .BR aio_suspend ()
 102 is not implemented.
 103 .SH VERSIONS
 104 The
 105 .BR aio_suspend ()
 106 function is available since glibc 2.1.
 107 .SH CONFORMING TO
 108 POSIX.1-2001, POSIX.1-2008.
 109 .SH NOTES
 110 One can achieve polling by using a non-NULL
 111 .I timeout
 112 that specifies a zero time interval.
 113
 114 If one or more of the asynchronous I/O operations specified in
 115 .IR aiocb_list
 116 has already completed at the time of the call to
 117 .BR aio_suspend (),
 118 then the call returns immediately.
 119
 120 To determine which I/O operations have completed
 121 after a successful return from
 122 .BR aio_suspend (),
 123 use
 124 .BR aio_error (3)
 125 to scan the list of
 126 .I aiocb
 127 structures pointed to by
 128 .IR aiocb_list .
 129 .SH SEE ALSO
 130 .BR aio_cancel (3),
 131 .BR aio_error (3),
 132 .BR aio_fsync (3),
 133 .BR aio_read (3),
 134 .BR aio_return (3),
 135 .BR aio_write (3),
 136 .BR lio_listio (3),
 137 .BR aio (7),
 138 .BR time (7)
 139 .SH COLOPHON
 140 This page is part of release 3.79 of the Linux
 141 .I man-pages
 142 project.
 143 A description of the project,
 144 information about reporting bugs,
 145 and the latest version of this page,
 146 can be found at
 147 \%http://www.kernel.org/doc/man\-pages/.