libs/beast/doc/html/beast/ref/boost__beast__http__error.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>http::error</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__empty_body__value_type.html" title="http::empty_body::value_type">
  10 <link rel="next" href="boost__beast__http__ext_list.html" title="http::ext_list">
  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__empty_body__value_type.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__ext_list.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__error"></a><a class="link" href="boost__beast__http__error.html" title="http::error">http::error</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873500334128"></a>
  31 Error codes returned from HTTP algorithms and operations.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__http__error.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__http__error.synopsis"></a></span><a class="link" href="boost__beast__http__error.html#beast.ref.boost__beast__http__error.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/http/error.hpp" target="_top">boost/beast/http/error.hpp</a>&gt;</code>
  39       </p>
  40 <pre class="programlisting"><span class="keyword">enum</span> <span class="identifier">error</span>
  41 </pre>
  42 <p>
  43         <a class="indexterm" name="idm45873500326144"></a>
  44  <a class="indexterm" name="idm45873500325040"></a>
  45  <a class="indexterm" name="idm45873500323936"></a>
  46  <a class="indexterm" name="idm45873500322832"></a>
  47  <a class="indexterm" name="idm45873500321728"></a>
  48  <a class="indexterm" name="idm45873500320624"></a>
  49  <a class="indexterm" name="idm45873500319520"></a>
  50  <a class="indexterm" name="idm45873500318416"></a>
  51  <a class="indexterm" name="idm45873500317312"></a>
  52  <a class="indexterm" name="idm45873500316208"></a>
  53  <a class="indexterm" name="idm45873500315104"></a>
  54  <a class="indexterm" name="idm45873500314000"></a>
  55  <a class="indexterm" name="idm45873500312896"></a>
  56  <a class="indexterm" name="idm45873500311792"></a>
  57  <a class="indexterm" name="idm45873500310688"></a>
  58  <a class="indexterm" name="idm45873500309584"></a>
  59  <a class="indexterm" name="idm45873500308480"></a>
  60  <a class="indexterm" name="idm45873500307376"></a>
  61  <a class="indexterm" name="idm45873500306272"></a>
  62  <a class="indexterm" name="idm45873500305168"></a>
  63  <a class="indexterm" name="idm45873500304064"></a>
  64  <a class="indexterm" name="idm45873500302960"></a>
  65  <a class="indexterm" name="idm45873500301856"></a>
  66  <a class="indexterm" name="idm45873500300752"></a>
  67
  68       </p>
  69 <h5>
  70 <a name="beast.ref.boost__beast__http__error.h1"></a>
  71         <span class="phrase"><a name="beast.ref.boost__beast__http__error.values"></a></span><a class="link" href="boost__beast__http__error.html#beast.ref.boost__beast__http__error.values">Values</a>
  72       </h5>
  73 <div class="informaltable"><table class="table">
  74 <colgroup>
  75 <col>
  76 <col>
  77 </colgroup>
  78 <thead><tr>
  79 <th>
  80                 <p>
  81                   Name
  82                 </p>
  83               </th>
  84 <th>
  85                 <p>
  86                   Description
  87                 </p>
  88               </th>
  89 </tr></thead>
  90 <tbody>
  91 <tr>
  92 <td>
  93                 <p>
  94                   <code class="literal">end_of_stream</code>
  95                 </p>
  96               </td>
  97 <td>
  98                 <p>
  99                   The end of the stream was reached.
 100                 </p>
 101                 <p>
 102                   This error is returned when attempting to read HTTP data, and the
 103                   stream returns the error <code class="computeroutput"><span class="identifier">net</span><span class="special">::</span><span class="identifier">error</span><span class="special">::</span><span class="identifier">eof</span></code>
 104                   before any octets corresponding to a new HTTP message have been
 105                   received.
 106                 </p>
 107               </td>
 108 </tr>
 109 <tr>
 110 <td>
 111                 <p>
 112                   <code class="literal">partial_message</code>
 113                 </p>
 114               </td>
 115 <td>
 116                 <p>
 117                   The incoming message is incomplete.
 118                 </p>
 119                 <p>
 120                   This happens when the end of stream is reached during parsing and
 121                   some octets have been received, but not the entire message.
 122                 </p>
 123               </td>
 124 </tr>
 125 <tr>
 126 <td>
 127                 <p>
 128                   <code class="literal">need_more</code>
 129                 </p>
 130               </td>
 131 <td>
 132                 <p>
 133                   Additional buffers are required.
 134                 </p>
 135                 <p>
 136                   This error is returned during parsing when additional octets are
 137                   needed. The caller should append more data to the existing buffer
 138                   and retry the parse operaetion.
 139                 </p>
 140               </td>
 141 </tr>
 142 <tr>
 143 <td>
 144                 <p>
 145                   <code class="literal">unexpected_body</code>
 146                 </p>
 147               </td>
 148 <td>
 149                 <p>
 150                   An unexpected body was encountered during parsing.
 151                 </p>
 152                 <p>
 153                   This error is returned when attempting to parse body octets into
 154                   a message container which has the @ref empty_body body type.
 155                 </p>
 156                 <p>
 157                   @see empty_body
 158                 </p>
 159               </td>
 160 </tr>
 161 <tr>
 162 <td>
 163                 <p>
 164                   <code class="literal">need_buffer</code>
 165                 </p>
 166               </td>
 167 <td>
 168                 <p>
 169                   Additional buffers are required.
 170                 </p>
 171                 <p>
 172                   This error is returned under the following conditions:
 173                 </p>
 174                 <p>
 175                   @li During serialization when using @ref buffer_body. The caller
 176                   should update the body to point to a new buffer or indicate that
 177                   there are no more octets in the body.
 178                 </p>
 179                 <p>
 180                   @li During parsing when using @ref buffer_body. The caller should
 181                   update the body to point to a new storage area to receive additional
 182                   body octets.
 183                 </p>
 184               </td>
 185 </tr>
 186 <tr>
 187 <td>
 188                 <p>
 189                   <code class="literal">end_of_chunk</code>
 190                 </p>
 191               </td>
 192 <td>
 193                 <p>
 194                   The end of a chunk was reached.
 195                 </p>
 196               </td>
 197 </tr>
 198 <tr>
 199 <td>
 200                 <p>
 201                   <code class="literal">buffer_overflow</code>
 202                 </p>
 203               </td>
 204 <td>
 205                 <p>
 206                   Buffer maximum exceeded.
 207                 </p>
 208                 <p>
 209                   This error is returned when reading HTTP content into a dynamic
 210                   buffer, and the operation would exceed the maximum size of the
 211                   buffer.
 212                 </p>
 213               </td>
 214 </tr>
 215 <tr>
 216 <td>
 217                 <p>
 218                   <code class="literal">header_limit</code>
 219                 </p>
 220               </td>
 221 <td>
 222                 <p>
 223                   Header limit exceeded.
 224                 </p>
 225                 <p>
 226                   The parser detected an incoming message header which exceeded a
 227                   configured limit.
 228                 </p>
 229               </td>
 230 </tr>
 231 <tr>
 232 <td>
 233                 <p>
 234                   <code class="literal">body_limit</code>
 235                 </p>
 236               </td>
 237 <td>
 238                 <p>
 239                   Body limit exceeded.
 240                 </p>
 241                 <p>
 242                   The parser detected an incoming message body which exceeded a configured
 243                   limit.
 244                 </p>
 245               </td>
 246 </tr>
 247 <tr>
 248 <td>
 249                 <p>
 250                   <code class="literal">bad_alloc</code>
 251                 </p>
 252               </td>
 253 <td>
 254                 <p>
 255                   A memory allocation failed.
 256                 </p>
 257                 <p>
 258                   When basic_fields throws std::bad_alloc, it is converted into this
 259                   error by @ref parser.
 260                 </p>
 261               </td>
 262 </tr>
 263 <tr>
 264 <td>
 265                 <p>
 266                   <code class="literal">bad_line_ending</code>
 267                 </p>
 268               </td>
 269 <td>
 270                 <p>
 271                   The line ending was malformed.
 272                 </p>
 273               </td>
 274 </tr>
 275 <tr>
 276 <td>
 277                 <p>
 278                   <code class="literal">bad_method</code>
 279                 </p>
 280               </td>
 281 <td>
 282                 <p>
 283                   The method is invalid.
 284                 </p>
 285               </td>
 286 </tr>
 287 <tr>
 288 <td>
 289                 <p>
 290                   <code class="literal">bad_target</code>
 291                 </p>
 292               </td>
 293 <td>
 294                 <p>
 295                   The request-target is invalid.
 296                 </p>
 297               </td>
 298 </tr>
 299 <tr>
 300 <td>
 301                 <p>
 302                   <code class="literal">bad_version</code>
 303                 </p>
 304               </td>
 305 <td>
 306                 <p>
 307                   The HTTP-version is invalid.
 308                 </p>
 309               </td>
 310 </tr>
 311 <tr>
 312 <td>
 313                 <p>
 314                   <code class="literal">bad_status</code>
 315                 </p>
 316               </td>
 317 <td>
 318                 <p>
 319                   The status-code is invalid.
 320                 </p>
 321               </td>
 322 </tr>
 323 <tr>
 324 <td>
 325                 <p>
 326                   <code class="literal">bad_reason</code>
 327                 </p>
 328               </td>
 329 <td>
 330                 <p>
 331                   The reason-phrase is invalid.
 332                 </p>
 333               </td>
 334 </tr>
 335 <tr>
 336 <td>
 337                 <p>
 338                   <code class="literal">bad_field</code>
 339                 </p>
 340               </td>
 341 <td>
 342                 <p>
 343                   The field name is invalid.
 344                 </p>
 345               </td>
 346 </tr>
 347 <tr>
 348 <td>
 349                 <p>
 350                   <code class="literal">bad_value</code>
 351                 </p>
 352               </td>
 353 <td>
 354                 <p>
 355                   The field value is invalid.
 356                 </p>
 357               </td>
 358 </tr>
 359 <tr>
 360 <td>
 361                 <p>
 362                   <code class="literal">bad_content_length</code>
 363                 </p>
 364               </td>
 365 <td>
 366                 <p>
 367                   The Content-Length is invalid.
 368                 </p>
 369               </td>
 370 </tr>
 371 <tr>
 372 <td>
 373                 <p>
 374                   <code class="literal">bad_transfer_encoding</code>
 375                 </p>
 376               </td>
 377 <td>
 378                 <p>
 379                   The Transfer-Encoding is invalid.
 380                 </p>
 381               </td>
 382 </tr>
 383 <tr>
 384 <td>
 385                 <p>
 386                   <code class="literal">bad_chunk</code>
 387                 </p>
 388               </td>
 389 <td>
 390                 <p>
 391                   The chunk syntax is invalid.
 392                 </p>
 393               </td>
 394 </tr>
 395 <tr>
 396 <td>
 397                 <p>
 398                   <code class="literal">bad_chunk_extension</code>
 399                 </p>
 400               </td>
 401 <td>
 402                 <p>
 403                   The chunk extension is invalid.
 404                 </p>
 405               </td>
 406 </tr>
 407 <tr>
 408 <td>
 409                 <p>
 410                   <code class="literal">bad_obs_fold</code>
 411                 </p>
 412               </td>
 413 <td>
 414                 <p>
 415                   An obs-fold exceeded an internal limit.
 416                 </p>
 417               </td>
 418 </tr>
 419 <tr>
 420 <td>
 421                 <p>
 422                   <code class="literal">stale_parser</code>
 423                 </p>
 424               </td>
 425 <td>
 426                 <p>
 427                   The parser is stale.
 428                 </p>
 429                 <p>
 430                   This happens when attempting to re-use a parser that has already
 431                   completed parsing a message. Programs must construct a new parser
 432                   for each message. This can be easily done by storing the parser
 433                   in an boost or std::optional container.
 434                 </p>
 435               </td>
 436 </tr>
 437 </tbody>
 438 </table></div>
 439 <h5>
 440 <a name="beast.ref.boost__beast__http__error.h2"></a>
 441         <span class="phrase"><a name="beast.ref.boost__beast__http__error.description"></a></span><a class="link" href="boost__beast__http__error.html#beast.ref.boost__beast__http__error.description">Description</a>
 442       </h5>
 443 <p>
 444         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/http.hpp" target="_top">boost/beast/http.hpp</a>&gt;</code>
 445       </p>
 446 </div>
 447 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 448 <td align="left"></td>
 449 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 450       Falco<p>
 451         Distributed under the Boost Software License, Version 1.0. (See accompanying
 452         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>)
 453       </p>
 454 </div></td>
 455 </tr></table>
 456 <hr>
 457 <div class="spirit-nav">
 458 <a accesskey="p" href="boost__beast__http__empty_body__value_type.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__ext_list.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 459 </div>
 460 </body>
 461 </html>