libs/beast/doc/html/beast/ref/boost__beast__async_base/complete.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>async_base::complete</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__async_base.html" title="async_base">
   9 <link rel="prev" href="async_base/overload3.html" title="async_base::async_base (3 of 3 overloads)">
  10 <link rel="next" href="complete_now.html" title="async_base::complete_now">
  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_base/overload3.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__async_base.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="complete_now.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__async_base.complete"></a><a class="link" href="complete.html" title="async_base::complete">async_base::complete</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873520193648"></a>
  31 Invoke the final completion handler, maybe using post.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__async_base.complete.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__async_base.complete.synopsis"></a></span><a class="link" href="complete.html#beast.ref.boost__beast__async_base.complete.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="special">...</span> <span class="identifier">Args</span><span class="special">&gt;</span>
  39 <span class="keyword">void</span>
  40 <span class="identifier">complete</span><span class="special">(</span>
  41     <span class="keyword">bool</span> <span class="identifier">is_continuation</span><span class="special">,</span>
  42     <span class="identifier">Args</span><span class="special">&amp;&amp;...</span> <span class="identifier">args</span><span class="special">);</span>
  43 </pre>
  44 <h6>
  45 <a name="beast.ref.boost__beast__async_base.complete.h1"></a>
  46           <span class="phrase"><a name="beast.ref.boost__beast__async_base.complete.description"></a></span><a class="link" href="complete.html#beast.ref.boost__beast__async_base.complete.description">Description</a>
  47         </h6>
  48 <p>
  49           This invokes the final completion handler with the specified arguments
  50           forwarded. It is undefined to call either of <a class="link" href="complete.html" title="async_base::complete"><code class="computeroutput"><span class="identifier">async_base</span><span class="special">::</span><span class="identifier">complete</span></code></a> or <a class="link" href="complete_now.html" title="async_base::complete_now"><code class="computeroutput"><span class="identifier">async_base</span><span class="special">::</span><span class="identifier">complete_now</span></code></a> more than once. Any
  51           temporary objects allocated with <a class="link" href="../boost__beast__allocate_stable.html" title="allocate_stable"><code class="computeroutput"><span class="identifier">allocate_stable</span></code></a> will be automatically
  52           destroyed before the final completion handler is invoked.
  53         </p>
  54 <h6>
  55 <a name="beast.ref.boost__beast__async_base.complete.h2"></a>
  56           <span class="phrase"><a name="beast.ref.boost__beast__async_base.complete.parameters"></a></span><a class="link" href="complete.html#beast.ref.boost__beast__async_base.complete.parameters">Parameters</a>
  57         </h6>
  58 <div class="informaltable"><table class="table">
  59 <colgroup>
  60 <col>
  61 <col>
  62 </colgroup>
  63 <thead><tr>
  64 <th>
  65                   <p>
  66                     Name
  67                   </p>
  68                 </th>
  69 <th>
  70                   <p>
  71                     Description
  72                   </p>
  73                 </th>
  74 </tr></thead>
  75 <tbody>
  76 <tr>
  77 <td>
  78                   <p>
  79                     <code class="computeroutput"><span class="identifier">is_continuation</span></code>
  80                   </p>
  81                 </td>
  82 <td>
  83                   <p>
  84                     If this value is <code class="computeroutput"><span class="keyword">false</span></code>,
  85                     then the handler will be submitted to the executor using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>. Otherwise the handler
  86                     will be invoked as if by calling <a class="link" href="complete_now.html" title="async_base::complete_now"><code class="computeroutput"><span class="identifier">async_base</span><span class="special">::</span><span class="identifier">complete_now</span></code></a>.
  87                   </p>
  88                 </td>
  89 </tr>
  90 <tr>
  91 <td>
  92                   <p>
  93                     <code class="computeroutput"><span class="identifier">args</span></code>
  94                   </p>
  95                 </td>
  96 <td>
  97                   <p>
  98                     A list of optional parameters to invoke the handler with. The
  99                     completion handler must be invocable with the parameter list,
 100                     or else a compilation error will result.
 101                   </p>
 102                 </td>
 103 </tr>
 104 </tbody>
 105 </table></div>
 106 </div>
 107 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 108 <td align="left"></td>
 109 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 110       Falco<p>
 111         Distributed under the Boost Software License, Version 1.0. (See accompanying
 112         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>)
 113       </p>
 114 </div></td>
 115 </tr></table>
 116 <hr>
 117 <div class="spirit-nav">
 118 <a accesskey="p" href="async_base/overload3.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__async_base.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="complete_now.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 119 </div>
 120 </body>
 121 </html>