1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>http::write (5 of 6 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__write.html" title="http::write"> 9<link rel="prev" href="overload4.html" title="http::write (4 of 6 overloads)"> 10<link rel="next" href="overload6.html" title="http::write (6 of 6 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="overload4.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__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="overload6.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__write.overload5"></a><a class="link" href="overload5.html" title="http::write (5 of 6 overloads)">http::write 28 (5 of 6 overloads)</a> 29</h5></div></div></div> 30<p> 31 Write a complete message to a stream. 32 </p> 33<h6> 34<a name="beast.ref.boost__beast__http__write.overload5.h0"></a> 35 <span class="phrase"><a name="beast.ref.boost__beast__http__write.overload5.synopsis"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__http__write.overload5.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/SyncWriteStream.html" target="_top"><span class="emphasis"><em>SyncWriteStream</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="identifier">std</span><span class="special">::</span><span class="identifier">size_t</span> 46<span class="identifier">write</span><span class="special">(</span> 47 <span class="identifier">SyncWriteStream</span><span class="special">&</span> <span class="identifier">stream</span><span class="special">,</span> 48 <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="identifier">msg</span><span class="special">,</span> 49 <span class="identifier">error_code</span><span class="special">&</span> <span class="identifier">ec</span><span class="special">);</span> 50</pre> 51<h6> 52<a name="beast.ref.boost__beast__http__write.overload5.h1"></a> 53 <span class="phrase"><a name="beast.ref.boost__beast__http__write.overload5.description"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__http__write.overload5.description">Description</a> 54 </h6> 55<p> 56 This function is used to write a complete message to a stream using HTTP/1. 57 The call will block until one of the following conditions is true: 58 </p> 59<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> 60<li class="listitem"> 61 The entire message is written. 62 </li> 63<li class="listitem"> 64 An error occurs. 65 </li> 66</ul></div> 67<p> 68 This operation is implemented in terms of one or more calls to the stream's 69 <code class="computeroutput"><span class="identifier">write_some</span></code> function. The 70 algorithm will use a temporary <a class="link" href="../boost__beast__http__serializer.html" title="http::serializer"><code class="computeroutput"><span class="identifier">serializer</span></code></a> with an empty chunk 71 decorator to produce buffers. 72 </p> 73<h6> 74<a name="beast.ref.boost__beast__http__write.overload5.h2"></a> 75 <span class="phrase"><a name="beast.ref.boost__beast__http__write.overload5.remarks"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__http__write.overload5.remarks">Remarks</a> 76 </h6> 77<p> 78 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">is_mutable_body_writer</span></code></a> for <span class="emphasis"><em>Body</em></span> 79 returns <code class="computeroutput"><span class="keyword">true</span></code>. 80 </p> 81<h6> 82<a name="beast.ref.boost__beast__http__write.overload5.h3"></a> 83 <span class="phrase"><a name="beast.ref.boost__beast__http__write.overload5.parameters"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__http__write.overload5.parameters">Parameters</a> 84 </h6> 85<div class="informaltable"><table class="table"> 86<colgroup> 87<col> 88<col> 89</colgroup> 90<thead><tr> 91<th> 92 <p> 93 Name 94 </p> 95 </th> 96<th> 97 <p> 98 Description 99 </p> 100 </th> 101</tr></thead> 102<tbody> 103<tr> 104<td> 105 <p> 106 <code class="computeroutput"><span class="identifier">stream</span></code> 107 </p> 108 </td> 109<td> 110 <p> 111 The stream to which the data is to be written. The type must 112 support the <span class="emphasis"><em>SyncWriteStream</em></span> concept. 113 </p> 114 </td> 115</tr> 116<tr> 117<td> 118 <p> 119 <code class="computeroutput"><span class="identifier">msg</span></code> 120 </p> 121 </td> 122<td> 123 <p> 124 The message to write. 125 </p> 126 </td> 127</tr> 128<tr> 129<td> 130 <p> 131 <code class="computeroutput"><span class="identifier">ec</span></code> 132 </p> 133 </td> 134<td> 135 <p> 136 Set to the error, if any occurred. 137 </p> 138 </td> 139</tr> 140</tbody> 141</table></div> 142<h6> 143<a name="beast.ref.boost__beast__http__write.overload5.h4"></a> 144 <span class="phrase"><a name="beast.ref.boost__beast__http__write.overload5.return_value"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__http__write.overload5.return_value">Return 145 Value</a> 146 </h6> 147<p> 148 The number of bytes written to the stream. 149 </p> 150<h6> 151<a name="beast.ref.boost__beast__http__write.overload5.h5"></a> 152 <span class="phrase"><a name="beast.ref.boost__beast__http__write.overload5.see_also"></a></span><a class="link" href="overload5.html#beast.ref.boost__beast__http__write.overload5.see_also">See Also</a> 153 </h6> 154<p> 155 <a class="link" href="../boost__beast__http__message.html" title="http::message"><code class="computeroutput"><span class="identifier">message</span></code></a> 156 </p> 157</div> 158<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 159<td align="left"></td> 160<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 161 Falco<p> 162 Distributed under the Boost Software License, Version 1.0. (See accompanying 163 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>) 164 </p> 165</div></td> 166</tr></table> 167<hr> 168<div class="spirit-nav"> 169<a accesskey="p" href="overload4.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__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="overload6.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 170</div> 171</body> 172</html> 173
