libs/beast/doc/html/beast/ref/boost__beast__http__response.html

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