3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
4 <title>http::async_write (3 of 3 overloads)</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__http__async_write.html" title="http::async_write">
9 <link rel="prev" href="overload2.html" title="http::async_write (2 of 3 overloads)">
10 <link rel="next" href="../boost__beast__http__async_write_header.html" title="http::async_write_header">
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>
22 <div class="spirit-nav">
23 <a accesskey="p" href="overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__async_write.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="../boost__beast__http__async_write_header.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
26 <div class="titlepage"><div><div><h5 class="title">
27 <a name="beast.ref.boost__beast__http__async_write.overload3"></a><a class="link" href="overload3.html" title="http::async_write (3 of 3 overloads)">http::async_write
28 (3 of 3 overloads)</a>
29 </h5></div></div></div>
31 Write a complete message to a stream asynchronously.
34 <a name="beast.ref.boost__beast__http__async_write.overload3.h0"></a>
35 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload3.synopsis"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__async_write.overload3.synopsis">Synopsis</a>
38 Defined in header <code class="literal"><<a href="../../../../../../../boost/beast/http/write.hpp" target="_top">boost/beast/http/write.hpp</a>></code>
40 <pre class="programlisting"><span class="keyword">template</span><span class="special"><</span>
41 <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/AsyncWriteStream.html" target="_top"><span class="emphasis"><em>AsyncWriteStream</em></span></a><span class="special">,</span>
42 <span class="keyword">bool</span> <span class="identifier">isRequest</span><span class="special">,</span>
43 <span class="keyword">class</span> <a class="link" href="../../concepts/Body.html" title="Body"><span class="emphasis"><em>Body</em></span></a><span class="special">,</span>
44 <span class="keyword">class</span> <a class="link" href="../../concepts/Fields.html" title="Fields"><span class="emphasis"><em>Fields</em></span></a><span class="special">,</span>
45 <span class="keyword">class</span> <a href="../../../../../../../doc/html/boost_asio/reference/WriteHandler.html" target="_top"><span class="emphasis"><em>WriteHandler</em></span></a> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special"><</span> <span class="identifier">executor_type</span><span class="special"><</span><span class="identifier">AsyncWriteStream</span><span class="special">>>></span>
46 <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>
47 <span class="identifier">async_write</span><span class="special">(</span>
48 <span class="identifier">AsyncWriteStream</span><span class="special">&</span> <span class="identifier">stream</span><span class="special">,</span>
49 <span class="identifier">message</span><span class="special"><</span> <span class="identifier">isRequest</span><span class="special">,</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">Fields</span> <span class="special">></span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">msg</span><span class="special">,</span>
50 <span class="identifier">WriteHandler</span><span class="special">&&</span> <span class="identifier">handler</span> <span class="special">=</span> <span class="identifier">net</span><span class="special">::</span><span class="identifier">default_completion_token_t</span><span class="special"><</span> <span class="identifier">executor_type</span><span class="special"><</span> <span class="identifier">AsyncWriteStream</span> <span class="special">>>{});</span>
53 <a name="beast.ref.boost__beast__http__async_write.overload3.h1"></a>
54 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload3.description"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__async_write.overload3.description">Description</a>
57 This function is used to write a complete message to a stream asynchronously
58 using HTTP/1. The function call always returns immediately. The asynchronous
59 operation will continue until one of the following conditions is true:
61 <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
63 The entire message is written.
70 This operation is implemented in terms of zero or more calls to the stream's
71 <code class="computeroutput"><span class="identifier">async_write_some</span></code> function,
72 and is known as a <span class="emphasis"><em>composed operation</em></span>. The program
73 must ensure that the stream performs no other writes until this operation
74 completes. The algorithm will use a temporary <a class="link" href="../boost__beast__http__serializer.html" title="http::serializer"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">serializer</span></code></a> with an empty chunk
75 decorator to produce buffers.
78 <a name="beast.ref.boost__beast__http__async_write.overload3.h2"></a>
79 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload3.remarks"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__async_write.overload3.remarks">Remarks</a>
82 This function only participates in overload resolution if <a class="link" href="../boost__beast__http__is_mutable_body_writer.html" title="http::is_mutable_body_writer"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">is_mutable_body_writer</span></code></a> for <span class="emphasis"><em>Body</em></span>
83 returns <code class="computeroutput"><span class="keyword">false</span></code>.
86 <a name="beast.ref.boost__beast__http__async_write.overload3.h3"></a>
87 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload3.parameters"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__async_write.overload3.parameters">Parameters</a>
89 <div class="informaltable"><table class="table">
110 <code class="computeroutput"><span class="identifier">stream</span></code>
115 The stream to which the data is to be written. The type must
116 support the <span class="emphasis"><em>AsyncWriteStream</em></span> concept.
123 <code class="computeroutput"><span class="identifier">msg</span></code>
128 The message to write. The object must remain valid at least until
129 the handler is called; ownership is not transferred.
136 <code class="computeroutput"><span class="identifier">handler</span></code>
141 The completion handler to invoke when the operation completes.
142 The implementation takes ownership of the handler by performing
143 a decay-copy. The equivalent function signature of the handler
146 <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>
147 <span class="identifier">error_code</span> <span class="keyword">const</span><span class="special">&</span> <span class="identifier">error</span><span class="special">,</span> <span class="comment">// result of operation</span>
148 <span class="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> <span class="identifier">bytes_transferred</span> <span class="comment">// the number of bytes written to the stream</span>
149 <span class="special">);</span>
152 Regardless of whether the asynchronous operation completes immediately
153 or not, the handler will not be invoked from within this function.
154 Invocation of the handler will be performed in a manner equivalent
155 to using <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code>.
162 <a name="beast.ref.boost__beast__http__async_write.overload3.h4"></a>
163 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload3.see_also"></a></span><a class="link" href="overload3.html#beast.ref.boost__beast__http__async_write.overload3.see_also">See
167 <a class="link" href="../boost__beast__http__message.html" title="http::message"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">message</span></code></a>
170 Convenience header <code class="literal"><<a href="../../../../../../../boost/beast/http.hpp" target="_top">boost/beast/http.hpp</a>></code>
173 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
174 <td align="left"></td>
175 <td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie
177 Distributed under the Boost Software License, Version 1.0. (See accompanying
178 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>)
183 <div class="spirit-nav">
184 <a accesskey="p" href="overload2.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__async_write.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="../boost__beast__http__async_write_header.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>