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