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