libs/beast/doc/html/beast/ref/boost__beast__http__response_header.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::response_header</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&#160;1.&#160;Boost.Beast">
   8 <link rel="up" href="../ref.html" title="This Page Intentionally Left Blank 2/2">
   9 <link rel="prev" href="boost__beast__http__response.html" title="http::response">
  10 <link rel="next" href="boost__beast__http__response_parser.html" title="http::response_parser">
  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__response.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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__response_parser.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
  24 </div>
  25 <div class="section">
  26 <div class="titlepage"><div><div><h4 class="title">
  27 <a name="beast.ref.boost__beast__http__response_header"></a><a class="link" href="boost__beast__http__response_header.html" title="http::response_header">http::response_header</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873491238768"></a>
  31 A typical HTTP response header.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__http__response_header.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__http__response_header.synopsis"></a></span><a class="link" href="boost__beast__http__response_header.html#beast.ref.boost__beast__http__response_header.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/http/message.hpp" target="_top">boost/beast/http/message.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">template</span><span class="special">&lt;</span>
  41     <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> <span class="identifier">fields</span><span class="special">&gt;</span>
  42 <span class="keyword">using</span> <span class="identifier">response_header</span> <span class="special">=</span> <span class="identifier">header</span><span class="special">&lt;</span> <span class="keyword">false</span><span class="special">,</span> <span class="identifier">Fields</span> <span class="special">&gt;;</span>
  43 </pre>
  44 <h5>
  45 <a name="beast.ref.boost__beast__http__response_header.h1"></a>
  46         <span class="phrase"><a name="beast.ref.boost__beast__http__response_header.types"></a></span><a class="link" href="boost__beast__http__response_header.html#beast.ref.boost__beast__http__response_header.types">Types</a>
  47       </h5>
  48 <div class="informaltable"><table class="table">
  49 <colgroup>
  50 <col>
  51 <col>
  52 </colgroup>
  53 <thead><tr>
  54 <th>
  55                 <p>
  56                   Name
  57                 </p>
  58               </th>
  59 <th>
  60                 <p>
  61                   Description
  62                 </p>
  63               </th>
  64 </tr></thead>
  65 <tbody>
  66 <tr>
  67 <td>
  68                 <p>
  69                   <a class="link" href="boost__beast__http__header/fields_type.html" title="http::header::fields_type"><span class="bold"><strong>fields_type</strong></span></a>
  70                 </p>
  71               </td>
  72 <td>
  73                 <p>
  74                   The type representing the fields.
  75                 </p>
  76               </td>
  77 </tr>
  78 <tr>
  79 <td>
  80                 <p>
  81                   <a class="link" href="boost__beast__http__header/is_request.html" title="http::header::is_request"><span class="bold"><strong>is_request</strong></span></a>
  82                 </p>
  83               </td>
  84 <td>
  85                 <p>
  86                   Indicates if the header is a request or response.
  87                 </p>
  88               </td>
  89 </tr>
  90 </tbody>
  91 </table></div>
  92 <h5>
  93 <a name="beast.ref.boost__beast__http__response_header.h2"></a>
  94         <span class="phrase"><a name="beast.ref.boost__beast__http__response_header.member_functions"></a></span><a class="link" href="boost__beast__http__response_header.html#beast.ref.boost__beast__http__response_header.member_functions">Member
  95         Functions</a>
  96       </h5>
  97 <div class="informaltable"><table class="table">
  98 <colgroup>
  99 <col>
 100 <col>
 101 </colgroup>
 102 <thead><tr>
 103 <th>
 104                 <p>
 105                   Name
 106                 </p>
 107               </th>
 108 <th>
 109                 <p>
 110                   Description
 111                 </p>
 112               </th>
 113 </tr></thead>
 114 <tbody>
 115 <tr>
 116 <td>
 117                 <p>
 118                   <a class="link" href="boost__beast__http__header/header.html" title="http::header::header"><span class="bold"><strong>header</strong></span></a>
 119                 </p>
 120               </td>
 121 <td>
 122                 <p>
 123                   Constructor.
 124                 </p>
 125               </td>
 126 </tr>
 127 <tr>
 128 <td>
 129                 <p>
 130                   <a class="link" href="boost__beast__http__header/method.html" title="http::header::method"><span class="bold"><strong>method</strong></span></a>
 131                 </p>
 132               </td>
 133 <td>
 134                 <p>
 135                   Return the request-method verb.
 136                 </p>
 137                 <p>
 138                   Set the request-method.
 139                 </p>
 140               </td>
 141 </tr>
 142 <tr>
 143 <td>
 144                 <p>
 145                   <a class="link" href="boost__beast__http__header/method_string.html" title="http::header::method_string"><span class="bold"><strong>method_string</strong></span></a>
 146                 </p>
 147               </td>
 148 <td>
 149                 <p>
 150                   Return the request-method as a string.
 151                 </p>
 152               </td>
 153 </tr>
 154 <tr>
 155 <td>
 156                 <p>
 157                   <a class="link" href="boost__beast__http__header/operator_eq_.html" title="http::header::operator="><span class="bold"><strong>operator=</strong></span></a>
 158                 </p>
 159               </td>
 160 <td>
 161                 <p>
 162                   Assignment.
 163                 </p>
 164               </td>
 165 </tr>
 166 <tr>
 167 <td>
 168                 <p>
 169                   <a class="link" href="boost__beast__http__header/reason.html" title="http::header::reason"><span class="bold"><strong>reason</strong></span></a>
 170                 </p>
 171               </td>
 172 <td>
 173                 <p>
 174                   Return the response reason-phrase.
 175                 </p>
 176                 <p>
 177                   Set the response reason-phrase (deprecated)
 178                 </p>
 179               </td>
 180 </tr>
 181 <tr>
 182 <td>
 183                 <p>
 184                   <a class="link" href="boost__beast__http__header/result.html" title="http::header::result"><span class="bold"><strong>result</strong></span></a>
 185                 </p>
 186               </td>
 187 <td>
 188                 <p>
 189                   The response status-code result.
 190                 </p>
 191                 <p>
 192                   Set the response status-code.
 193                 </p>
 194                 <p>
 195                   Set the response status-code as an integer.
 196                 </p>
 197               </td>
 198 </tr>
 199 <tr>
 200 <td>
 201                 <p>
 202                   <a class="link" href="boost__beast__http__header/result_int.html" title="http::header::result_int"><span class="bold"><strong>result_int</strong></span></a>
 203                 </p>
 204               </td>
 205 <td>
 206                 <p>
 207                   The response status-code expressed as an integer.
 208                 </p>
 209               </td>
 210 </tr>
 211 <tr>
 212 <td>
 213                 <p>
 214                   <a class="link" href="boost__beast__http__header/target.html" title="http::header::target"><span class="bold"><strong>target</strong></span></a>
 215                 </p>
 216               </td>
 217 <td>
 218                 <p>
 219                   Returns the request-target string.
 220                 </p>
 221                 <p>
 222                   Set the request-target string.
 223                 </p>
 224               </td>
 225 </tr>
 226 <tr>
 227 <td>
 228                 <p>
 229                   <a class="link" href="boost__beast__http__header/version.html" title="http::header::version"><span class="bold"><strong>version</strong></span></a>
 230                 </p>
 231               </td>
 232 <td>
 233                 <p>
 234                   Return the HTTP-version.
 235                 </p>
 236                 <p>
 237                   Set the HTTP-version.
 238                 </p>
 239               </td>
 240 </tr>
 241 </tbody>
 242 </table></div>
 243 <p>
 244         This container is derived from the <code class="computeroutput"><span class="identifier">Fields</span></code>
 245         template type. To understand all of the members of this class it is necessary
 246         to view the declaration for the <code class="computeroutput"><span class="identifier">Fields</span></code>
 247         type. When using the default fields container, those declarations are in
 248         <a class="link" href="boost__beast__http__fields.html" title="http::fields"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">fields</span></code></a>.
 249         Newly constructed header objects have version set to HTTP/1.1. Newly constructed
 250         response objects also have result code set to <a class="link" href="boost__beast__http__status.html" title="http::status"><code class="computeroutput"><span class="identifier">http</span><span class="special">::</span><span class="identifier">ok</span></code></a>. A <code class="computeroutput"><span class="identifier">header</span></code>
 251         includes the start-line and header-fields.
 252       </p>
 253 <h5>
 254 <a name="beast.ref.boost__beast__http__response_header.h3"></a>
 255         <span class="phrase"><a name="beast.ref.boost__beast__http__response_header.description"></a></span><a class="link" href="boost__beast__http__response_header.html#beast.ref.boost__beast__http__response_header.description">Description</a>
 256       </h5>
 257 <p>
 258         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/http.hpp" target="_top">boost/beast/http.hpp</a>&gt;</code>
 259       </p>
 260 </div>
 261 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 262 <td align="left"></td>
 263 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 264       Falco<p>
 265         Distributed under the Boost Software License, Version 1.0. (See accompanying
 266         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>)
 267       </p>
 268 </div></td>
 269 </tr></table>
 270 <hr>
 271 <div class="spirit-nav">
 272 <a accesskey="p" href="boost__beast__http__response.html"><img src="../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../ref.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__response_parser.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 273 </div>
 274 </body>
 275 </html>