libs/beast/doc/html/beast/ref/boost__beast__http__message/header_type.html

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