libs/beast/doc/html/beast/ref/boost__beast__ssl_stream/async_shutdown.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>ssl_stream::async_shutdown</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__ssl_stream.html" title="ssl_stream">
   9 <link rel="prev" href="async_read_some.html" title="ssl_stream::async_read_some">
  10 <link rel="next" href="async_write_some.html" title="ssl_stream::async_write_some">
  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="async_read_some.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__ssl_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="async_write_some.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__ssl_stream.async_shutdown"></a><a class="link" href="async_shutdown.html" title="ssl_stream::async_shutdown">ssl_stream::async_shutdown</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873484223600"></a>
  31 Asynchronously shut down SSL on the stream.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__ssl_stream.async_shutdown.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_shutdown.synopsis"></a></span><a class="link" href="async_shutdown.html#beast.ref.boost__beast__ssl_stream.async_shutdown.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  38     <span class="keyword">class</span> <span class="identifier">ShutdownHandler</span><span class="special">&gt;</span>
  39 <a href="../../../../../../../doc/html/boost_asio/reference/asynchronous_operations.html#boost_asio.reference.asynchronous_operations.automatic_deduction_of_initiating_function_return_type" target="_top"><span class="emphasis"><em>DEDUCED</em></span></a>
  40 <span class="identifier">async_shutdown</span><span class="special">(</span>
  41     <span class="identifier">BOOST_ASIO_MOVE_ARG</span><span class="special">(</span><span class="identifier">ShutdownHandler</span><span class="special">)</span> <span class="identifier">handler</span><span class="special">);</span>
  42 </pre>
  43 <h6>
  44 <a name="beast.ref.boost__beast__ssl_stream.async_shutdown.h1"></a>
  45           <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_shutdown.description"></a></span><a class="link" href="async_shutdown.html#beast.ref.boost__beast__ssl_stream.async_shutdown.description">Description</a>
  46         </h6>
  47 <p>
  48           This function is used to asynchronously shut down SSL on the stream. This
  49           function call always returns immediately.
  50         </p>
  51 <h6>
  52 <a name="beast.ref.boost__beast__ssl_stream.async_shutdown.h2"></a>
  53           <span class="phrase"><a name="beast.ref.boost__beast__ssl_stream.async_shutdown.parameters"></a></span><a class="link" href="async_shutdown.html#beast.ref.boost__beast__ssl_stream.async_shutdown.parameters">Parameters</a>
  54         </h6>
  55 <div class="informaltable"><table class="table">
  56 <colgroup>
  57 <col>
  58 <col>
  59 </colgroup>
  60 <thead><tr>
  61 <th>
  62                   <p>
  63                     Name
  64                   </p>
  65                 </th>
  66 <th>
  67                   <p>
  68                     Description
  69                   </p>
  70                 </th>
  71 </tr></thead>
  72 <tbody><tr>
  73 <td>
  74                   <p>
  75                     <code class="computeroutput"><span class="identifier">handler</span></code>
  76                   </p>
  77                 </td>
  78 <td>
  79                   <p>
  80                     The handler to be called when the handshake operation completes.
  81                     Copies will be made of the handler as required. The equivalent
  82                     function signature of the handler must be:
  83                   </p>
  84 <pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"> <span class="keyword">void</span> <span class="identifier">handler</span><span class="special">(</span>
  85   <span class="keyword">const</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">system</span><span class="special">::</span><span class="identifier">error_code</span><span class="special">&amp;</span> <span class="identifier">error</span> <span class="comment">// Result of operation.</span>
  86 <span class="special">);</span>
  87 </pre>
  88                 </td>
  89 </tr></tbody>
  90 </table></div>
  91 </div>
  92 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
  93 <td align="left"></td>
  94 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
  95       Falco<p>
  96         Distributed under the Boost Software License, Version 1.0. (See accompanying
  97         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>)
  98       </p>
  99 </div></td>
 100 </tr></table>
 101 <hr>
 102 <div class="spirit-nav">
 103 <a accesskey="p" href="async_read_some.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__ssl_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="async_write_some.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 104 </div>
 105 </body>
 106 </html>