1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>http::header::reason (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="../reason.html" title="http::header::reason"> 9<link rel="prev" href="overload1.html" title="http::header::reason (1 of 2 overloads)"> 10<link rel="next" href="../../boost__beast__http__icy_stream.html" title="http::icy_stream"> 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="../reason.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__icy_stream.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h6 class="title"> 27<a name="beast.ref.boost__beast__http__header.reason.overload2"></a><a class="link" href="overload2.html" title="http::header::reason (2 of 2 overloads)">http::header::reason 28 (2 of 2 overloads)</a> 29</h6></div></div></div> 30<p> 31 Set the response reason-phrase (deprecated) 32 </p> 33<h7><a name="beast.ref.boost__beast__http__header.reason.overload2.h0"></a> 34 <span class="phrase"><a name="beast.ref.boost__beast__http__header.reason.overload2.synopsis"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__header.reason.overload2.synopsis">Synopsis</a> 35 </h7><pre class="programlisting"><span class="keyword">void</span> 36<span class="identifier">reason</span><span class="special">(</span> 37 <span class="identifier">string_view</span> <span class="identifier">s</span><span class="special">);</span> 38</pre> 39<h7><a name="beast.ref.boost__beast__http__header.reason.overload2.h1"></a> 40 <span class="phrase"><a name="beast.ref.boost__beast__http__header.reason.overload2.description"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__header.reason.overload2.description">Description</a> 41 </h7><p> 42 This function sets a custom reason-phrase to a copy of the string passed 43 in. Normally it is not necessary to set the reason phrase on an outgoing 44 response object; the implementation will automatically use the standard 45 reason text for the corresponding status code. To clear a previously 46 set custom phrase, pass an empty string. This will restore the default 47 standard reason text based on the status code used when serializing. 48 The reason-phrase is obsolete as of rfc7230. 49 </p> 50<h7><a name="beast.ref.boost__beast__http__header.reason.overload2.h2"></a> 51 <span class="phrase"><a name="beast.ref.boost__beast__http__header.reason.overload2.parameters"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__header.reason.overload2.parameters">Parameters</a> 52 </h7><div class="informaltable"><table class="table"> 53<colgroup> 54<col> 55<col> 56</colgroup> 57<thead><tr> 58<th> 59 <p> 60 Name 61 </p> 62 </th> 63<th> 64 <p> 65 Description 66 </p> 67 </th> 68</tr></thead> 69<tbody><tr> 70<td> 71 <p> 72 <code class="computeroutput"><span class="identifier">s</span></code> 73 </p> 74 </td> 75<td> 76 <p> 77 The string to use for the reason-phrase. 78 </p> 79 </td> 80</tr></tbody> 81</table></div> 82<h7><a name="beast.ref.boost__beast__http__header.reason.overload2.h3"></a> 83 <span class="phrase"><a name="beast.ref.boost__beast__http__header.reason.overload2.remarks"></a></span><a class="link" href="overload2.html#beast.ref.boost__beast__http__header.reason.overload2.remarks">Remarks</a> 84 </h7><p> 85 This function is only available when <code class="computeroutput"><span class="identifier">isRequest</span> 86 <span class="special">==</span> <span class="keyword">false</span></code>. 87 </p> 88</div> 89<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 90<td align="left"></td> 91<td align="right"><div class="copyright-footer">Copyright © 2016-2019 Vinnie 92 Falco<p> 93 Distributed under the Boost Software License, Version 1.0. (See accompanying 94 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>) 95 </p> 96</div></td> 97</tr></table> 98<hr> 99<div class="spirit-nav"> 100<a accesskey="p" href="overload1.html"><img src="../../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../reason.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__icy_stream.html"><img src="../../../../../../../../doc/src/images/next.png" alt="Next"></a> 101</div> 102</body> 103</html> 104
