247 lines
5.7 KiB
HTML
247 lines
5.7 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of AIO_SUSPEND</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>AIO_SUSPEND</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2017-09-15<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
aio_suspend - wait for asynchronous I/O operation or timeout
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<PRE>
|
|
|
|
<B>#include <<A HREF="file:///usr/include/aio.h">aio.h</A>></B>
|
|
|
|
<B>int aio_suspend(const struct aiocb * const </B><I>aiocb_list</I><B>[],</B>
|
|
<B> int </B><I>nitems</I><B>, const struct timespec *</B><I>timeout</I><B>);</B>
|
|
|
|
Link with <I>-lrt</I>.
|
|
</PRE>
|
|
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>aio_suspend</B>()
|
|
|
|
function suspends the calling thread until one of the following occurs:
|
|
<DL COMPACT>
|
|
<DT id="1">*<DD>
|
|
One or more of the asynchronous I/O requests in the list
|
|
<I>aiocb_list</I>
|
|
|
|
has completed.
|
|
<DT id="2">*<DD>
|
|
A signal is delivered.
|
|
<DT id="3">*<DD>
|
|
<I>timeout</I>
|
|
|
|
is not NULL and the specified time interval has passed.
|
|
(For details of the
|
|
<I>timespec</I>
|
|
|
|
structure, see
|
|
<B><A HREF="/cgi-bin/man/man2html?2+nanosleep">nanosleep</A></B>(2).)
|
|
|
|
</DL>
|
|
<P>
|
|
|
|
The
|
|
<I>nitems</I>
|
|
|
|
argument specifies the number of items in
|
|
<I>aiocb_list</I>.
|
|
|
|
Each item in the list pointed to by
|
|
<I>aiocb_list</I>
|
|
|
|
must be either NULL (and then is ignored),
|
|
or a pointer to a control block on which I/O was initiated using
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_read">aio_read</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_write">aio_write</A></B>(3),
|
|
|
|
or
|
|
<B><A HREF="/cgi-bin/man/man2html?3+lio_listio">lio_listio</A></B>(3).
|
|
|
|
(See
|
|
<B><A HREF="/cgi-bin/man/man2html?7+aio">aio</A></B>(7)
|
|
|
|
for a description of the
|
|
<I>aiocb</I>
|
|
|
|
structure.)
|
|
<P>
|
|
|
|
If
|
|
<B>CLOCK_MONOTONIC</B>
|
|
|
|
is supported, this clock is used to measure
|
|
the timeout interval (see
|
|
<B><A HREF="/cgi-bin/man/man2html?3+clock_gettime">clock_gettime</A></B>(3)).
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
If this function returns after completion of one of the I/O
|
|
requests specified in
|
|
<I>aiocb_list</I>,
|
|
|
|
0 is returned.
|
|
Otherwise, -1 is returned, and
|
|
<I>errno</I>
|
|
|
|
is set to indicate the error.
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ERRORS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="4"><B>EAGAIN</B>
|
|
|
|
<DD>
|
|
The call timed out before any of the indicated operations
|
|
had completed.
|
|
<DT id="5"><B>EINTR</B>
|
|
|
|
<DD>
|
|
The call was ended by signal
|
|
(possibly the completion signal of one of the operations we were
|
|
waiting for); see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+signal">signal</A></B>(7).
|
|
|
|
<DT id="6"><B>ENOSYS</B>
|
|
|
|
<DD>
|
|
<B>aio_suspend</B>()
|
|
|
|
is not implemented.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>VERSIONS</H2>
|
|
|
|
The
|
|
<B>aio_suspend</B>()
|
|
|
|
function is available since glibc 2.1.
|
|
<A NAME="lbAH"> </A>
|
|
<H2>ATTRIBUTES</H2>
|
|
|
|
For an explanation of the terms used in this section, see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+attributes">attributes</A></B>(7).
|
|
|
|
<TABLE BORDER>
|
|
<TR VALIGN=top><TD><B>Interface</B></TD><TD><B>Attribute</B></TD><TD><B>Value</B><BR></TD></TR>
|
|
<TR VALIGN=top><TD>
|
|
<B>aio_suspend</B>()
|
|
|
|
</TD><TD>Thread safety</TD><TD>MT-Safe<BR></TD></TR>
|
|
</TABLE>
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H2>CONFORMING TO</H2>
|
|
|
|
POSIX.1-2001, POSIX.1-2008.
|
|
<A NAME="lbAJ"> </A>
|
|
<H2>NOTES</H2>
|
|
|
|
One can achieve polling by using a non-NULL
|
|
<I>timeout</I>
|
|
|
|
that specifies a zero time interval.
|
|
<P>
|
|
|
|
If one or more of the asynchronous I/O operations specified in
|
|
<I>aiocb_list</I>
|
|
|
|
has already completed at the time of the call to
|
|
<B>aio_suspend</B>(),
|
|
|
|
then the call returns immediately.
|
|
<P>
|
|
|
|
To determine which I/O operations have completed
|
|
after a successful return from
|
|
<B>aio_suspend</B>(),
|
|
|
|
use
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_error">aio_error</A></B>(3)
|
|
|
|
to scan the list of
|
|
<I>aiocb</I>
|
|
|
|
structures pointed to by
|
|
<I>aiocb_list</I>.
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>BUGS</H2>
|
|
|
|
The glibc implementation of
|
|
<B>aio_suspend</B>()
|
|
|
|
is not async-signal-safe,
|
|
|
|
in violation of the requirements of POSIX.1.
|
|
<A NAME="lbAL"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_cancel">aio_cancel</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_error">aio_error</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_fsync">aio_fsync</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_read">aio_read</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_return">aio_return</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_write">aio_write</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?3+lio_listio">lio_listio</A></B>(3),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+aio">aio</A></B>(7),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?7+time">time</A></B>(7)
|
|
|
|
<A NAME="lbAM"> </A>
|
|
<H2>COLOPHON</H2>
|
|
|
|
This page is part of release 5.05 of the Linux
|
|
<I>man-pages</I>
|
|
|
|
project.
|
|
A description of the project,
|
|
information about reporting bugs,
|
|
and the latest version of this page,
|
|
can be found at
|
|
<A HREF="https://www.kernel.org/doc/man-pages/.">https://www.kernel.org/doc/man-pages/.</A>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="7"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="8"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="9"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="10"><A HREF="#lbAE">RETURN VALUE</A><DD>
|
|
<DT id="11"><A HREF="#lbAF">ERRORS</A><DD>
|
|
<DT id="12"><A HREF="#lbAG">VERSIONS</A><DD>
|
|
<DT id="13"><A HREF="#lbAH">ATTRIBUTES</A><DD>
|
|
<DT id="14"><A HREF="#lbAI">CONFORMING TO</A><DD>
|
|
<DT id="15"><A HREF="#lbAJ">NOTES</A><DD>
|
|
<DT id="16"><A HREF="#lbAK">BUGS</A><DD>
|
|
<DT id="17"><A HREF="#lbAL">SEE ALSO</A><DD>
|
|
<DT id="18"><A HREF="#lbAM">COLOPHON</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:05:35 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|