libs/beast/doc/html/beast/ref/boost__beast__basic_stream/cancel.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>basic_stream::cancel</title>
   5 <link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css">
   6 <meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
   7 <link rel="home" href="../../../index.html" title="Chapter&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../boost__beast__basic_stream.html" title="basic_stream">
   9 <link rel="prev" href="basic_stream/overload3.html" title="basic_stream::basic_stream (3 of 3 overloads)">
  10 <link rel="next" href="close.html" title="basic_stream::close">
  11 </head>
  12 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
  13 <table cellpadding="2" width="100%"><tr>
  14 <td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td>
  15 <td align="center"><a href="../../../../../../../index.html">Home</a></td>
  16 <td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td>
  17 <td align="center"><a href="http://www.boost.org/users/people.html">People</a></td>
  18 <td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td>
  19 <td align="center"><a href="../../../../../../../more/index.htm">More</a></td>
  20 </tr></table>
  21 <hr>
  22 <div class="spirit-nav">
  23 <a accesskey="p" href="basic_stream/overload3.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="close.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h5 class="title">
  27 <a name="beast.ref.boost__beast__basic_stream.cancel"></a><a class="link" href="cancel.html" title="basic_stream::cancel">basic_stream::cancel</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873516189888"></a>
  31 Cancel all asynchronous operations associated with the
  32           socket.
  33         </p>
  34 <h6>
  35 <a name="beast.ref.boost__beast__basic_stream.cancel.h0"></a>
  36           <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.cancel.synopsis"></a></span><a class="link" href="cancel.html#beast.ref.boost__beast__basic_stream.cancel.synopsis">Synopsis</a>
  37         </h6>
  38 <pre class="programlisting"><span class="keyword">void</span>
  39 <span class="identifier">cancel</span><span class="special">();</span>
  40 </pre>
  41 <h6>
  42 <a name="beast.ref.boost__beast__basic_stream.cancel.h1"></a>
  43           <span class="phrase"><a name="beast.ref.boost__beast__basic_stream.cancel.description"></a></span><a class="link" href="cancel.html#beast.ref.boost__beast__basic_stream.cancel.description">Description</a>
  44         </h6>
  45 <p>
  46           This function causes all outstanding asynchronous connect, read, and write
  47           operations to finish immediately. Completion handlers for cancelled operations
  48           will receive the error <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">operation_aborted</span></code>.
  49           Completion handlers not yet invoked whose operations have completed, will
  50           receive the error corresponding to the result of the operation (which may
  51           indicate success).
  52         </p>
  53 </div>
  54 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  55 <td align="left"></td>
  56 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  57       Falco<p>
  58         Distributed under the Boost Software License, Version 1.0. (See accompanying
  59         file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
  60       </p>
  61 </div></td>
  62 </tr></table>
  63 <hr>
  64 <div class="spirit-nav">
  65 <a accesskey="p" href="basic_stream/overload3.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__basic_stream.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="close.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
  66 </div>
  67 </body>
  68 </html>