226 lines
5.2 KiB
HTML
226 lines
5.2 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of AIO_CANCEL</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>AIO_CANCEL</H1>
|
|
Section: Linux Programmer's Manual (3)<BR>Updated: 2015-03-02<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_cancel - cancel an outstanding asynchronous I/O request
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<B>#include <<A HREF="file:///usr/include/aio.h">aio.h</A>></B>
|
|
|
|
<P>
|
|
|
|
<B>int aio_cancel(int </B><I>fd</I><B>, struct aiocb *</B><I>aiocbp</I><B>);</B>
|
|
|
|
<P>
|
|
|
|
Link with <I>-lrt</I>.
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
The
|
|
<B>aio_cancel</B>()
|
|
|
|
function attempts to cancel outstanding asynchronous I/O requests
|
|
for the file descriptor
|
|
<I>fd</I>.
|
|
|
|
If
|
|
<I>aiocbp</I>
|
|
|
|
is NULL, all such requests are canceled.
|
|
Otherwise, only the request
|
|
described by the control block pointed to by
|
|
<I>aiocbp</I>
|
|
|
|
is canceled.
|
|
(See
|
|
<B><A HREF="/cgi-bin/man/man2html?7+aio">aio</A></B>(7)
|
|
|
|
for a description of the
|
|
<I>aiocb</I>
|
|
|
|
structure.)
|
|
<P>
|
|
|
|
Normal asynchronous notification occurs for canceled requests (see
|
|
<B><A HREF="/cgi-bin/man/man2html?7+aio">aio</A></B>(7)
|
|
|
|
and
|
|
<B><A HREF="/cgi-bin/man/man2html?7+sigevent">sigevent</A></B>(7)).
|
|
|
|
The request return status
|
|
(<B><A HREF="/cgi-bin/man/man2html?3+aio_return">aio_return</A></B>(3))
|
|
|
|
is set to -1, and the request error status
|
|
(<B><A HREF="/cgi-bin/man/man2html?3+aio_error">aio_error</A></B>(3))
|
|
|
|
is set to
|
|
<B>ECANCELED</B>.
|
|
|
|
The control block of requests that cannot be canceled is not changed.
|
|
<P>
|
|
|
|
If the request could not be canceled,
|
|
then it will terminate in the usual way after performing the I/O operation.
|
|
(In this case,
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_error">aio_error</A></B>(3)
|
|
|
|
will return the status
|
|
<B>EINPROGRESSS</B>.)
|
|
|
|
<P>
|
|
|
|
If
|
|
<I>aiocbp</I>
|
|
|
|
is not NULL, and
|
|
<I>fd</I>
|
|
|
|
differs from the file descriptor with which the asynchronous operation
|
|
was initiated, unspecified results occur.
|
|
<P>
|
|
|
|
Which operations are cancelable is implementation-defined.
|
|
|
|
<A NAME="lbAE"> </A>
|
|
<H2>RETURN VALUE</H2>
|
|
|
|
The
|
|
<B>aio_cancel</B>()
|
|
|
|
function returns one of the following values:
|
|
<DL COMPACT>
|
|
<DT id="1"><B>AIO_CANCELED</B>
|
|
|
|
<DD>
|
|
All requests were successfully canceled.
|
|
<DT id="2"><B>AIO_NOTCANCELED</B>
|
|
|
|
<DD>
|
|
At least one of the
|
|
requests specified was not canceled because it was in progress.
|
|
In this case, one may check the status of individual requests using
|
|
<B><A HREF="/cgi-bin/man/man2html?3+aio_error">aio_error</A></B>(3).
|
|
|
|
<DT id="3"><B>AIO_ALLDONE</B>
|
|
|
|
<DD>
|
|
All requests had already been completed before the call.
|
|
<DT id="4">-1<DD>
|
|
An error occurred.
|
|
The cause of the error can be found by inspecting
|
|
<I>errno</I>.
|
|
|
|
</DL>
|
|
<A NAME="lbAF"> </A>
|
|
<H2>ERRORS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="5"><B>EBADF</B>
|
|
|
|
<DD>
|
|
<I>fd</I>
|
|
|
|
is not a valid file descriptor.
|
|
<DT id="6"><B>ENOSYS</B>
|
|
|
|
<DD>
|
|
<B>aio_cancel</B>()
|
|
|
|
is not implemented.
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H2>VERSIONS</H2>
|
|
|
|
The
|
|
<B>aio_cancel</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_cancel</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>EXAMPLE</H2>
|
|
|
|
See
|
|
<B><A HREF="/cgi-bin/man/man2html?7+aio">aio</A></B>(7).
|
|
|
|
<A NAME="lbAK"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<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_suspend">aio_suspend</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)
|
|
|
|
<A NAME="lbAL"> </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">EXAMPLE</A><DD>
|
|
<DT id="16"><A HREF="#lbAK">SEE ALSO</A><DD>
|
|
<DT id="17"><A HREF="#lbAL">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>
|