libs/beast/doc/html/beast/ref/boost__beast__http__parser/value_type.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::parser::value_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__parser.html" title="http::parser">
   9 <link rel="prev" href="upgrade.html" title="http::parser::upgrade">
  10 <link rel="next" href="parser_dtor_.html" title="http::parser::~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="upgrade.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__parser.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="parser_dtor_.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__parser.value_type"></a><a class="link" href="value_type.html" title="http::parser::value_type">http::parser::value_type</a>
  28 </h5></div></div></div>
  29 <p>
  30           <a class="indexterm" name="idm45873492991936"></a>
  31 The type of message returned by the parser.
  32         </p>
  33 <h6>
  34 <a name="beast.ref.boost__beast__http__parser.value_type.h0"></a>
  35           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.value_type.synopsis"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__parser.value_type.synopsis">Synopsis</a>
  36         </h6>
  37 <pre class="programlisting"><span class="keyword">using</span> <span class="identifier">value_type</span> <span class="special">=</span> <span class="identifier">message</span><span class="special">&lt;</span> <span class="identifier">isRequest</span><span class="special">,</span> <span class="identifier">Body</span><span class="special">,</span> <span class="identifier">basic_fields</span><span class="special">&lt;</span> <span class="identifier">Allocator</span> <span class="special">&gt;</span> <span class="special">&gt;;</span>
  38 </pre>
  39 <h6>
  40 <a name="beast.ref.boost__beast__http__parser.value_type.h1"></a>
  41           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.value_type.types"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__parser.value_type.types">Types</a>
  42         </h6>
  43 <div class="informaltable"><table class="table">
  44 <colgroup>
  45 <col>
  46 <col>
  47 </colgroup>
  48 <thead><tr>
  49 <th>
  50                   <p>
  51                     Name
  52                   </p>
  53                 </th>
  54 <th>
  55                   <p>
  56                     Description
  57                   </p>
  58                 </th>
  59 </tr></thead>
  60 <tbody>
  61 <tr>
  62 <td>
  63                   <p>
  64                     <a class="link" href="../boost__beast__http__message/body_type.html" title="http::message::body_type"><span class="bold"><strong>body_type</strong></span></a>
  65                   </p>
  66                 </td>
  67 <td>
  68                   <p>
  69                     The type providing the body traits.
  70                   </p>
  71                 </td>
  72 </tr>
  73 <tr>
  74 <td>
  75                   <p>
  76                     <a class="link" href="../boost__beast__http__message/fields_type.html" title="http::message::fields_type"><span class="bold"><strong>fields_type</strong></span></a>
  77                   </p>
  78                 </td>
  79 <td>
  80                   <p>
  81                     The type representing the fields.
  82                   </p>
  83                 </td>
  84 </tr>
  85 <tr>
  86 <td>
  87                   <p>
  88                     <a class="link" href="../boost__beast__http__message/header_type.html" title="http::message::header_type"><span class="bold"><strong>header_type</strong></span></a>
  89                   </p>
  90                 </td>
  91 <td>
  92                   <p>
  93                     The base class used to hold the header portion of the message.
  94                   </p>
  95                 </td>
  96 </tr>
  97 <tr>
  98 <td>
  99                   <p>
 100                     <a class="link" href="../boost__beast__http__message/is_request.html" title="http::message::is_request"><span class="bold"><strong>is_request</strong></span></a>
 101                   </p>
 102                 </td>
 103 <td>
 104                   <p>
 105                     Indicates if the header is a request or response.
 106                   </p>
 107                 </td>
 108 </tr>
 109 </tbody>
 110 </table></div>
 111 <h6>
 112 <a name="beast.ref.boost__beast__http__parser.value_type.h2"></a>
 113           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.value_type.member_functions"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__parser.value_type.member_functions">Member
 114           Functions</a>
 115         </h6>
 116 <div class="informaltable"><table class="table">
 117 <colgroup>
 118 <col>
 119 <col>
 120 </colgroup>
 121 <thead><tr>
 122 <th>
 123                   <p>
 124                     Name
 125                   </p>
 126                 </th>
 127 <th>
 128                   <p>
 129                     Description
 130                   </p>
 131                 </th>
 132 </tr></thead>
 133 <tbody>
 134 <tr>
 135 <td>
 136                   <p>
 137                     <a class="link" href="../boost__beast__http__message/base.html" title="http::message::base"><span class="bold"><strong>base</strong></span></a>
 138                   </p>
 139                 </td>
 140 <td>
 141                   <p>
 142                     Returns the header portion of the message.
 143                   </p>
 144                 </td>
 145 </tr>
 146 <tr>
 147 <td>
 148                   <p>
 149                     <a class="link" href="../boost__beast__http__message/body.html" title="http::message::body"><span class="bold"><strong>body</strong></span></a>
 150                   </p>
 151                 </td>
 152 <td>
 153                   <p>
 154                     Returns the body.
 155                   </p>
 156                 </td>
 157 </tr>
 158 <tr>
 159 <td>
 160                   <p>
 161                     <a class="link" href="../boost__beast__http__message/chunked.html" title="http::message::chunked"><span class="bold"><strong>chunked</strong></span></a>
 162                   </p>
 163                 </td>
 164 <td>
 165                   <p>
 166                     Returns true if the chunked Transfer-Encoding is specified.
 167                   </p>
 168                   <p>
 169                     Set or clear the chunked Transfer-Encoding.
 170                   </p>
 171                 </td>
 172 </tr>
 173 <tr>
 174 <td>
 175                   <p>
 176                     <a class="link" href="../boost__beast__http__message/content_length.html" title="http::message::content_length"><span class="bold"><strong>content_length</strong></span></a>
 177                   </p>
 178                 </td>
 179 <td>
 180                   <p>
 181                     Set or clear the Content-Length field.
 182                   </p>
 183                 </td>
 184 </tr>
 185 <tr>
 186 <td>
 187                   <p>
 188                     <a class="link" href="../boost__beast__http__message/has_content_length.html" title="http::message::has_content_length"><span class="bold"><strong>has_content_length</strong></span></a>
 189                   </p>
 190                 </td>
 191 <td>
 192                   <p>
 193                     Returns true if the Content-Length field is present.
 194                   </p>
 195                 </td>
 196 </tr>
 197 <tr>
 198 <td>
 199                   <p>
 200                     <a class="link" href="../boost__beast__http__message/keep_alive.html" title="http::message::keep_alive"><span class="bold"><strong>keep_alive</strong></span></a>
 201                   </p>
 202                 </td>
 203 <td>
 204                   <p>
 205                     Returns true if the message semantics indicate keep-alive.
 206                   </p>
 207                   <p>
 208                     Set the keep-alive message semantic option.
 209                   </p>
 210                 </td>
 211 </tr>
 212 <tr>
 213 <td>
 214                   <p>
 215                     <a class="link" href="../boost__beast__http__message/message.html" title="http::message::message"><span class="bold"><strong>message</strong></span></a>
 216                   </p>
 217                 </td>
 218 <td>
 219                   <p>
 220                     Constructor.
 221                   </p>
 222                   <p>
 223                     Construct a message.
 224                   </p>
 225                 </td>
 226 </tr>
 227 <tr>
 228 <td>
 229                   <p>
 230                     <a class="link" href="../boost__beast__http__message/method.html" title="http::message::method"><span class="bold"><strong>method</strong></span></a>
 231                   </p>
 232                 </td>
 233 <td>
 234                   <p>
 235                     Return the request-method verb.
 236                   </p>
 237                   <p>
 238                     Set the request-method.
 239                   </p>
 240                 </td>
 241 </tr>
 242 <tr>
 243 <td>
 244                   <p>
 245                     <a class="link" href="../boost__beast__http__message/method_string.html" title="http::message::method_string"><span class="bold"><strong>method_string</strong></span></a>
 246                   </p>
 247                 </td>
 248 <td>
 249                   <p>
 250                     Return the request-method as a string.
 251                   </p>
 252                 </td>
 253 </tr>
 254 <tr>
 255 <td>
 256                   <p>
 257                     <a class="link" href="../boost__beast__http__message/need_eof.html" title="http::message::need_eof"><span class="bold"><strong>need_eof</strong></span></a>
 258                   </p>
 259                 </td>
 260 <td>
 261                   <p>
 262                     Returns true if the message semantics require an end of file.
 263                   </p>
 264                 </td>
 265 </tr>
 266 <tr>
 267 <td>
 268                   <p>
 269                     <a class="link" href="../boost__beast__http__message/operator_eq_.html" title="http::message::operator="><span class="bold"><strong>operator=</strong></span></a>
 270                   </p>
 271                 </td>
 272 <td>
 273                   <p>
 274                     Assignment.
 275                   </p>
 276                 </td>
 277 </tr>
 278 <tr>
 279 <td>
 280                   <p>
 281                     <a class="link" href="../boost__beast__http__message/payload_size.html" title="http::message::payload_size"><span class="bold"><strong>payload_size</strong></span></a>
 282                   </p>
 283                 </td>
 284 <td>
 285                   <p>
 286                     Returns the payload size of the body in octets if possible.
 287                   </p>
 288                 </td>
 289 </tr>
 290 <tr>
 291 <td>
 292                   <p>
 293                     <a class="link" href="../boost__beast__http__message/prepare_payload.html" title="http::message::prepare_payload"><span class="bold"><strong>prepare_payload</strong></span></a>
 294                   </p>
 295                 </td>
 296 <td>
 297                   <p>
 298                     Prepare the message payload fields for the body.
 299                   </p>
 300                 </td>
 301 </tr>
 302 <tr>
 303 <td>
 304                   <p>
 305                     <a class="link" href="../boost__beast__http__message/reason.html" title="http::message::reason"><span class="bold"><strong>reason</strong></span></a>
 306                   </p>
 307                 </td>
 308 <td>
 309                   <p>
 310                     Return the response reason-phrase.
 311                   </p>
 312                   <p>
 313                     Set the response reason-phrase (deprecated)
 314                   </p>
 315                 </td>
 316 </tr>
 317 <tr>
 318 <td>
 319                   <p>
 320                     <a class="link" href="../boost__beast__http__message/result.html" title="http::message::result"><span class="bold"><strong>result</strong></span></a>
 321                   </p>
 322                 </td>
 323 <td>
 324                   <p>
 325                     The response status-code result.
 326                   </p>
 327                   <p>
 328                     Set the response status-code.
 329                   </p>
 330                   <p>
 331                     Set the response status-code as an integer.
 332                   </p>
 333                 </td>
 334 </tr>
 335 <tr>
 336 <td>
 337                   <p>
 338                     <a class="link" href="../boost__beast__http__message/result_int.html" title="http::message::result_int"><span class="bold"><strong>result_int</strong></span></a>
 339                   </p>
 340                 </td>
 341 <td>
 342                   <p>
 343                     The response status-code expressed as an integer.
 344                   </p>
 345                 </td>
 346 </tr>
 347 <tr>
 348 <td>
 349                   <p>
 350                     <a class="link" href="../boost__beast__http__message/target.html" title="http::message::target"><span class="bold"><strong>target</strong></span></a>
 351                   </p>
 352                 </td>
 353 <td>
 354                   <p>
 355                     Returns the request-target string.
 356                   </p>
 357                   <p>
 358                     Set the request-target string.
 359                   </p>
 360                 </td>
 361 </tr>
 362 <tr>
 363 <td>
 364                   <p>
 365                     <a class="link" href="../boost__beast__http__message/version.html" title="http::message::version"><span class="bold"><strong>version</strong></span></a>
 366                   </p>
 367                 </td>
 368 <td>
 369                   <p>
 370                     Return the HTTP-version.
 371                   </p>
 372                   <p>
 373                     Set the HTTP-version.
 374                   </p>
 375                 </td>
 376 </tr>
 377 </tbody>
 378 </table></div>
 379 <p>
 380           This container is derived from the <code class="computeroutput"><span class="identifier">Fields</span></code>
 381           template type. To understand all of the members of this class it is necessary
 382           to view the declaration for the <code class="computeroutput"><span class="identifier">Fields</span></code>
 383           type. When using the default fields container, those declarations are in
 384           <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>.
 385           A message can be a request or response, depending on the <code class="computeroutput"><span class="identifier">isRequest</span></code> template argument value. Requests
 386           and responses have different types; functions may be overloaded based on
 387           the type if desired. The <code class="computeroutput"><span class="identifier">Body</span></code>
 388           template argument type determines the model used to read or write the content
 389           body of the message. Newly constructed messages objects have version set
 390           to HTTP/1.1. Newly constructed response objects also have result code set
 391           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>.
 392         </p>
 393 <h6>
 394 <a name="beast.ref.boost__beast__http__parser.value_type.h3"></a>
 395           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.value_type.template_parameters"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__parser.value_type.template_parameters">Template
 396           Parameters</a>
 397         </h6>
 398 <div class="informaltable"><table class="table">
 399 <colgroup>
 400 <col>
 401 <col>
 402 </colgroup>
 403 <thead><tr>
 404 <th>
 405                   <p>
 406                     Type
 407                   </p>
 408                 </th>
 409 <th>
 410                   <p>
 411                     Description
 412                   </p>
 413                 </th>
 414 </tr></thead>
 415 <tbody>
 416 <tr>
 417 <td>
 418                   <p>
 419                     <code class="computeroutput"><span class="identifier">isRequest</span></code>
 420                   </p>
 421                 </td>
 422 <td>
 423                   <p>
 424                     <code class="computeroutput"><span class="keyword">true</span></code> if this represents
 425                     a request, or <code class="computeroutput"><span class="keyword">false</span></code>
 426                     if this represents a response. Some class data members are conditionally
 427                     present depending on this value.
 428                   </p>
 429                 </td>
 430 </tr>
 431 <tr>
 432 <td>
 433                   <p>
 434                     <code class="computeroutput"><span class="identifier">Body</span></code>
 435                   </p>
 436                 </td>
 437 <td>
 438                   <p>
 439                     A type meeting the requirements of Body.
 440                   </p>
 441                 </td>
 442 </tr>
 443 <tr>
 444 <td>
 445                   <p>
 446                     <code class="computeroutput"><span class="identifier">Fields</span></code>
 447                   </p>
 448                 </td>
 449 <td>
 450                   <p>
 451                     The type of container used to hold the field value pairs.
 452                   </p>
 453                 </td>
 454 </tr>
 455 </tbody>
 456 </table></div>
 457 <h6>
 458 <a name="beast.ref.boost__beast__http__parser.value_type.h4"></a>
 459           <span class="phrase"><a name="beast.ref.boost__beast__http__parser.value_type.description"></a></span><a class="link" href="value_type.html#beast.ref.boost__beast__http__parser.value_type.description">Description</a>
 460         </h6>
 461 </div>
 462 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 463 <td align="left"></td>
 464 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 465       Falco<p>
 466         Distributed under the Boost Software License, Version 1.0. (See accompanying
 467         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>)
 468       </p>
 469 </div></td>
 470 </tr></table>
 471 <hr>
 472 <div class="spirit-nav">
 473 <a accesskey="p" href="upgrade.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../boost__beast__http__parser.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="parser_dtor_.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a>
 474 </div>
 475 </body>
 476 </html>