1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>http::async_write (1 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="../boost__beast__http__async_write.html" title="http::async_write"> 10<link rel="next" href="overload2.html" title="http::async_write (2 of 3 overloads)"> 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="../boost__beast__http__async_write.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="overload2.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__http__async_write.overload1"></a><a class="link" href="overload1.html" title="http::async_write (1 of 3 overloads)">http::async_write 28 (1 of 3 overloads)</a> 29</h5></div></div></div> 30<p> 31 Write a complete message to a stream asynchronously using a serializer. 32 </p> 33<h6> 34<a name="beast.ref.boost__beast__http__async_write.overload1.h0"></a> 35 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload1.synopsis"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__http__async_write.overload1.synopsis">Synopsis</a> 36 </h6> 37<p> 38 Defined in header <code class="literal"><<a href="../../../../../../../boost/beast/http/write.hpp" target="_top">boost/beast/http/write.hpp</a>></code> 39 </p> 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">serializer</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="identifier">sr</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> <a class="link" href="../boost__beast__executor_type.html" title="executor_type">executor_type</a><span class="special"><</span> <span class="identifier">AsyncWriteStream</span> <span class="special">>>{});</span> 51</pre> 52<h6> 53<a name="beast.ref.boost__beast__http__async_write.overload1.h1"></a> 54 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload1.description"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__http__async_write.overload1.description">Description</a> 55 </h6> 56<p> 57 This function is used to write a complete message to a stream asynchronously 58 using a caller-provided HTTP/1 serializer. The function call always returns 59 immediately. The asynchronous operation will continue until one of the 60 following conditions is true: 61 </p> 62<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 63<li class="listitem"> 64 The function <a class="link" href="../boost__beast__http__serializer/is_done.html" title="http::serializer::is_done"><code class="computeroutput"><span class="identifier">serializer</span><span class="special">::</span><span class="identifier">is_done</span></code></a> returns <code class="computeroutput"><span class="keyword">true</span></code> 65 </li> 66<li class="listitem"> 67 An error occurs. 68 </li> 69</ul></div> 70<p> 71 This operation is implemented in terms of zero or more calls to the stream's 72 <code class="computeroutput"><span class="identifier">async_write_some</span></code> function, 73 and is known as a <span class="emphasis"><em>composed operation</em></span>. The program 74 must ensure that the stream performs no other writes until this operation 75 completes. 76 </p> 77<h6> 78<a name="beast.ref.boost__beast__http__async_write.overload1.h2"></a> 79 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload1.parameters"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__http__async_write.overload1.parameters">Parameters</a> 80 </h6> 81<div class="informaltable"><table class="table"> 82<colgroup> 83<col> 84<col> 85</colgroup> 86<thead><tr> 87<th> 88 <p> 89 Name 90 </p> 91 </th> 92<th> 93 <p> 94 Description 95 </p> 96 </th> 97</tr></thead> 98<tbody> 99<tr> 100<td> 101 <p> 102 <code class="computeroutput"><span class="identifier">stream</span></code> 103 </p> 104 </td> 105<td> 106 <p> 107 The stream to which the data is to be written. The type must 108 support the <span class="emphasis"><em>AsyncWriteStream</em></span> concept. 109 </p> 110 </td> 111</tr> 112<tr> 113<td> 114 <p> 115 <code class="computeroutput"><span class="identifier">sr</span></code> 116 </p> 117 </td> 118<td> 119 <p> 120 The serializer to use. The object must remain valid at least 121 until the handler is called; ownership is not transferred. 122 </p> 123 </td> 124</tr> 125<tr> 126<td> 127 <p> 128 <code class="computeroutput"><span class="identifier">handler</span></code> 129 </p> 130 </td> 131<td> 132 <p> 133 The completion handler to invoke when the operation completes. 134 The implementation takes ownership of the handler by performing 135 a decay-copy. The equivalent function signature of the handler 136 must be: 137 </p> 138<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> 139 <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> 140 <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> 141<span class="special">);</span> 142</pre> 143 <p> 144 Regardless of whether the asynchronous operation completes immediately 145 or not, the handler will not be invoked from within this function. 146 Invocation of the handler will be performed in a manner equivalent 147 to using <a class="link" href="../boost__beast__http__verb.html" title="http::verb"><code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">post</span></code></a>. 148 </p> 149 </td> 150</tr> 151</tbody> 152</table></div> 153<h6> 154<a name="beast.ref.boost__beast__http__async_write.overload1.h3"></a> 155 <span class="phrase"><a name="beast.ref.boost__beast__http__async_write.overload1.see_also"></a></span><a class="link" href="overload1.html#beast.ref.boost__beast__http__async_write.overload1.see_also">See 156 Also</a> 157 </h6> 158<p> 159 <a class="link" href="../boost__beast__http__serializer.html" title="http::serializer"><code class="computeroutput"><span class="identifier">serializer</span></code></a> 160 </p> 161</div> 162<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 163<td align="left"></td> 164<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 165 Falco<p> 166 Distributed under the Boost Software License, Version 1.0. (See accompanying 167 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>) 168 </p> 169</div></td> 170</tr></table> 171<hr> 172<div class="spirit-nav"> 173<a accesskey="p" href="../boost__beast__http__async_write.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="overload2.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 174</div> 175</body> 176</html> 177
