libs/beast/doc/html/beast/ref/boost__beast__websocket__error.html

   1 <html>
   2 <head>
   3 <meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
   4 <title>websocket::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__websocket__condition.html" title="websocket::condition">
  10 <link rel="next" href="boost__beast__websocket__frame_type.html" title="websocket::frame_type">
  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__websocket__condition.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__websocket__frame_type.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__websocket__error"></a><a class="link" href="boost__beast__websocket__error.html" title="websocket::error">websocket::error</a>
  28 </h4></div></div></div>
  29 <p>
  30         <a class="indexterm" name="idm45873475277728"></a>
  31 Error codes returned from <a class="link" href="boost__beast__websocket__stream.html" title="websocket::stream"><code class="computeroutput"><span class="identifier">websocket</span><span class="special">::</span><span class="identifier">stream</span></code></a> operations.
  32       </p>
  33 <h5>
  34 <a name="beast.ref.boost__beast__websocket__error.h0"></a>
  35         <span class="phrase"><a name="beast.ref.boost__beast__websocket__error.synopsis"></a></span><a class="link" href="boost__beast__websocket__error.html#beast.ref.boost__beast__websocket__error.synopsis">Synopsis</a>
  36       </h5>
  37 <p>
  38         Defined in header <code class="literal">&lt;<a href="../../../../../../boost/beast/websocket/error.hpp" target="_top">boost/beast/websocket/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="idm45873475266832"></a>
  44  <a class="indexterm" name="idm45873475265728"></a>
  45  <a class="indexterm" name="idm45873475264624"></a>
  46  <a class="indexterm" name="idm45873475263520"></a>
  47  <a class="indexterm" name="idm45873475262416"></a>
  48  <a class="indexterm" name="idm45873475261312"></a>
  49  <a class="indexterm" name="idm45873475260208"></a>
  50  <a class="indexterm" name="idm45873475259104"></a>
  51  <a class="indexterm" name="idm45873475258000"></a>
  52  <a class="indexterm" name="idm45873475256896"></a>
  53  <a class="indexterm" name="idm45873475255792"></a>
  54  <a class="indexterm" name="idm45873475254688"></a>
  55  <a class="indexterm" name="idm45873475253584"></a>
  56  <a class="indexterm" name="idm45873475252480"></a>
  57  <a class="indexterm" name="idm45873475251376"></a>
  58  <a class="indexterm" name="idm45873475250272"></a>
  59  <a class="indexterm" name="idm45873475249168"></a>
  60  <a class="indexterm" name="idm45873475248064"></a>
  61  <a class="indexterm" name="idm45873475246960"></a>
  62  <a class="indexterm" name="idm45873475245856"></a>
  63  <a class="indexterm" name="idm45873475244752"></a>
  64  <a class="indexterm" name="idm45873475243648"></a>
  65  <a class="indexterm" name="idm45873475242544"></a>
  66  <a class="indexterm" name="idm45873475241440"></a>
  67  <a class="indexterm" name="idm45873475240336"></a>
  68  <a class="indexterm" name="idm45873475239232"></a>
  69  <a class="indexterm" name="idm45873475238128"></a>
  70  <a class="indexterm" name="idm45873475237024"></a>
  71  <a class="indexterm" name="idm45873475235920"></a>
  72  <a class="indexterm" name="idm45873475234816"></a>
  73  <a class="indexterm" name="idm45873475233712"></a>
  74
  75       </p>
  76 <h5>
  77 <a name="beast.ref.boost__beast__websocket__error.h1"></a>
  78         <span class="phrase"><a name="beast.ref.boost__beast__websocket__error.values"></a></span><a class="link" href="boost__beast__websocket__error.html#beast.ref.boost__beast__websocket__error.values">Values</a>
  79       </h5>
  80 <div class="informaltable"><table class="table">
  81 <colgroup>
  82 <col>
  83 <col>
  84 </colgroup>
  85 <thead><tr>
  86 <th>
  87                 <p>
  88                   Name
  89                 </p>
  90               </th>
  91 <th>
  92                 <p>
  93                   Description
  94                 </p>
  95               </th>
  96 </tr></thead>
  97 <tbody>
  98 <tr>
  99 <td>
 100                 <p>
 101                   <code class="literal">closed</code>
 102                 </p>
 103               </td>
 104 <td>
 105                 <p>
 106                   The WebSocket stream was gracefully closed at both endpoints.
 107                 </p>
 108               </td>
 109 </tr>
 110 <tr>
 111 <td>
 112                 <p>
 113                   <code class="literal">buffer_overflow</code>
 114                 </p>
 115               </td>
 116 <td>
 117                 <p>
 118                   The WebSocket operation caused a dynamic buffer overflow.
 119                 </p>
 120               </td>
 121 </tr>
 122 <tr>
 123 <td>
 124                 <p>
 125                   <code class="literal">partial_deflate_block</code>
 126                 </p>
 127               </td>
 128 <td>
 129                 <p>
 130                   The WebSocket stream produced an incomplete deflate block.
 131                 </p>
 132               </td>
 133 </tr>
 134 <tr>
 135 <td>
 136                 <p>
 137                   <code class="literal">message_too_big</code>
 138                 </p>
 139               </td>
 140 <td>
 141                 <p>
 142                   The WebSocket message exceeded the locally configured limit.
 143                 </p>
 144               </td>
 145 </tr>
 146 <tr>
 147 <td>
 148                 <p>
 149                   <code class="literal">bad_http_version</code>
 150                 </p>
 151               </td>
 152 <td>
 153                 <p>
 154                   The WebSocket handshake was not HTTP/1.1.
 155                 </p>
 156                 <p>
 157                   Error codes with this value will compare equal to @ref condition::handshake_failed
 158                 </p>
 159               </td>
 160 </tr>
 161 <tr>
 162 <td>
 163                 <p>
 164                   <code class="literal">bad_method</code>
 165                 </p>
 166               </td>
 167 <td>
 168                 <p>
 169                   The WebSocket handshake method was not GET.
 170                 </p>
 171                 <p>
 172                   Error codes with this value will compare equal to @ref condition::handshake_failed
 173                 </p>
 174               </td>
 175 </tr>
 176 <tr>
 177 <td>
 178                 <p>
 179                   <code class="literal">no_host</code>
 180                 </p>
 181               </td>
 182 <td>
 183                 <p>
 184                   The WebSocket handshake Host field is missing.
 185                 </p>
 186                 <p>
 187                   Error codes with this value will compare equal to @ref condition::handshake_failed
 188                 </p>
 189               </td>
 190 </tr>
 191 <tr>
 192 <td>
 193                 <p>
 194                   <code class="literal">no_connection</code>
 195                 </p>
 196               </td>
 197 <td>
 198                 <p>
 199                   The WebSocket handshake Connection field is missing.
 200                 </p>
 201                 <p>
 202                   Error codes with this value will compare equal to @ref condition::handshake_failed
 203                 </p>
 204               </td>
 205 </tr>
 206 <tr>
 207 <td>
 208                 <p>
 209                   <code class="literal">no_connection_upgrade</code>
 210                 </p>
 211               </td>
 212 <td>
 213                 <p>
 214                   The WebSocket handshake Connection field is missing the upgrade
 215                   token.
 216                 </p>
 217                 <p>
 218                   Error codes with this value will compare equal to @ref condition::handshake_failed
 219                 </p>
 220               </td>
 221 </tr>
 222 <tr>
 223 <td>
 224                 <p>
 225                   <code class="literal">no_upgrade</code>
 226                 </p>
 227               </td>
 228 <td>
 229                 <p>
 230                   The WebSocket handshake Upgrade field is missing.
 231                 </p>
 232                 <p>
 233                   Error codes with this value will compare equal to @ref condition::handshake_failed
 234                 </p>
 235               </td>
 236 </tr>
 237 <tr>
 238 <td>
 239                 <p>
 240                   <code class="literal">no_upgrade_websocket</code>
 241                 </p>
 242               </td>
 243 <td>
 244                 <p>
 245                   The WebSocket handshake Upgrade field is missing the websocket
 246                   token.
 247                 </p>
 248                 <p>
 249                   Error codes with this value will compare equal to @ref condition::handshake_failed
 250                 </p>
 251               </td>
 252 </tr>
 253 <tr>
 254 <td>
 255                 <p>
 256                   <code class="literal">no_sec_key</code>
 257                 </p>
 258               </td>
 259 <td>
 260                 <p>
 261                   The WebSocket handshake Sec-WebSocket-Key field is missing.
 262                 </p>
 263                 <p>
 264                   Error codes with this value will compare equal to @ref condition::handshake_failed
 265                 </p>
 266               </td>
 267 </tr>
 268 <tr>
 269 <td>
 270                 <p>
 271                   <code class="literal">bad_sec_key</code>
 272                 </p>
 273               </td>
 274 <td>
 275                 <p>
 276                   The WebSocket handshake Sec-WebSocket-Key field is invalid.
 277                 </p>
 278                 <p>
 279                   Error codes with this value will compare equal to @ref condition::handshake_failed
 280                 </p>
 281               </td>
 282 </tr>
 283 <tr>
 284 <td>
 285                 <p>
 286                   <code class="literal">no_sec_version</code>
 287                 </p>
 288               </td>
 289 <td>
 290                 <p>
 291                   The WebSocket handshake Sec-WebSocket-Version field is missing.
 292                 </p>
 293                 <p>
 294                   Error codes with this value will compare equal to @ref condition::handshake_failed
 295                 </p>
 296               </td>
 297 </tr>
 298 <tr>
 299 <td>
 300                 <p>
 301                   <code class="literal">bad_sec_version</code>
 302                 </p>
 303               </td>
 304 <td>
 305                 <p>
 306                   The WebSocket handshake Sec-WebSocket-Version field is invalid.
 307                 </p>
 308                 <p>
 309                   Error codes with this value will compare equal to @ref condition::handshake_failed
 310                 </p>
 311               </td>
 312 </tr>
 313 <tr>
 314 <td>
 315                 <p>
 316                   <code class="literal">no_sec_accept</code>
 317                 </p>
 318               </td>
 319 <td>
 320                 <p>
 321                   The WebSocket handshake Sec-WebSocket-Accept field is missing.
 322                 </p>
 323                 <p>
 324                   Error codes with this value will compare equal to @ref condition::handshake_failed
 325                 </p>
 326               </td>
 327 </tr>
 328 <tr>
 329 <td>
 330                 <p>
 331                   <code class="literal">bad_sec_accept</code>
 332                 </p>
 333               </td>
 334 <td>
 335                 <p>
 336                   The WebSocket handshake Sec-WebSocket-Accept field is invalid.
 337                 </p>
 338                 <p>
 339                   Error codes with this value will compare equal to @ref condition::handshake_failed
 340                 </p>
 341               </td>
 342 </tr>
 343 <tr>
 344 <td>
 345                 <p>
 346                   <code class="literal">upgrade_declined</code>
 347                 </p>
 348               </td>
 349 <td>
 350                 <p>
 351                   The WebSocket handshake was declined by the remote peer.
 352                 </p>
 353                 <p>
 354                   Error codes with this value will compare equal to @ref condition::handshake_failed
 355                 </p>
 356               </td>
 357 </tr>
 358 <tr>
 359 <td>
 360                 <p>
 361                   <code class="literal">bad_opcode</code>
 362                 </p>
 363               </td>
 364 <td>
 365                 <p>
 366                   The WebSocket frame contained an illegal opcode.
 367                 </p>
 368                 <p>
 369                   Error codes with this value will compare equal to @ref condition::protocol_violation
 370                 </p>
 371               </td>
 372 </tr>
 373 <tr>
 374 <td>
 375                 <p>
 376                   <code class="literal">bad_data_frame</code>
 377                 </p>
 378               </td>
 379 <td>
 380                 <p>
 381                   The WebSocket data frame was unexpected.
 382                 </p>
 383                 <p>
 384                   Error codes with this value will compare equal to @ref condition::protocol_violation
 385                 </p>
 386               </td>
 387 </tr>
 388 <tr>
 389 <td>
 390                 <p>
 391                   <code class="literal">bad_continuation</code>
 392                 </p>
 393               </td>
 394 <td>
 395                 <p>
 396                   The WebSocket continuation frame was unexpected.
 397                 </p>
 398                 <p>
 399                   Error codes with this value will compare equal to @ref condition::protocol_violation
 400                 </p>
 401               </td>
 402 </tr>
 403 <tr>
 404 <td>
 405                 <p>
 406                   <code class="literal">bad_reserved_bits</code>
 407                 </p>
 408               </td>
 409 <td>
 410                 <p>
 411                   The WebSocket frame contained illegal reserved bits.
 412                 </p>
 413                 <p>
 414                   Error codes with this value will compare equal to @ref condition::protocol_violation
 415                 </p>
 416               </td>
 417 </tr>
 418 <tr>
 419 <td>
 420                 <p>
 421                   <code class="literal">bad_control_fragment</code>
 422                 </p>
 423               </td>
 424 <td>
 425                 <p>
 426                   The WebSocket control frame was fragmented.
 427                 </p>
 428                 <p>
 429                   Error codes with this value will compare equal to @ref condition::protocol_violation
 430                 </p>
 431               </td>
 432 </tr>
 433 <tr>
 434 <td>
 435                 <p>
 436                   <code class="literal">bad_control_size</code>
 437                 </p>
 438               </td>
 439 <td>
 440                 <p>
 441                   The WebSocket control frame size was invalid.
 442                 </p>
 443                 <p>
 444                   Error codes with this value will compare equal to @ref condition::protocol_violation
 445                 </p>
 446               </td>
 447 </tr>
 448 <tr>
 449 <td>
 450                 <p>
 451                   <code class="literal">bad_unmasked_frame</code>
 452                 </p>
 453               </td>
 454 <td>
 455                 <p>
 456                   The WebSocket frame was unmasked.
 457                 </p>
 458                 <p>
 459                   Error codes with this value will compare equal to @ref condition::protocol_violation
 460                 </p>
 461               </td>
 462 </tr>
 463 <tr>
 464 <td>
 465                 <p>
 466                   <code class="literal">bad_masked_frame</code>
 467                 </p>
 468               </td>
 469 <td>
 470                 <p>
 471                   The WebSocket frame was masked.
 472                 </p>
 473                 <p>
 474                   Error codes with this value will compare equal to @ref condition::protocol_violation
 475                 </p>
 476               </td>
 477 </tr>
 478 <tr>
 479 <td>
 480                 <p>
 481                   <code class="literal">bad_size</code>
 482                 </p>
 483               </td>
 484 <td>
 485                 <p>
 486                   The WebSocket frame size was not canonical.
 487                 </p>
 488                 <p>
 489                   Error codes with this value will compare equal to @ref condition::protocol_violation
 490                 </p>
 491               </td>
 492 </tr>
 493 <tr>
 494 <td>
 495                 <p>
 496                   <code class="literal">bad_frame_payload</code>
 497                 </p>
 498               </td>
 499 <td>
 500                 <p>
 501                   The WebSocket frame payload was not valid utf8.
 502                 </p>
 503                 <p>
 504                   Error codes with this value will compare equal to @ref condition::protocol_violation
 505                 </p>
 506               </td>
 507 </tr>
 508 <tr>
 509 <td>
 510                 <p>
 511                   <code class="literal">bad_close_code</code>
 512                 </p>
 513               </td>
 514 <td>
 515                 <p>
 516                   The WebSocket close frame reason code was invalid.
 517                 </p>
 518                 <p>
 519                   Error codes with this value will compare equal to @ref condition::protocol_violation
 520                 </p>
 521               </td>
 522 </tr>
 523 <tr>
 524 <td>
 525                 <p>
 526                   <code class="literal">bad_close_size</code>
 527                 </p>
 528               </td>
 529 <td>
 530                 <p>
 531                   The WebSocket close frame payload size was invalid.
 532                 </p>
 533                 <p>
 534                   Error codes with this value will compare equal to @ref condition::protocol_violation
 535                 </p>
 536               </td>
 537 </tr>
 538 <tr>
 539 <td>
 540                 <p>
 541                   <code class="literal">bad_close_payload</code>
 542                 </p>
 543               </td>
 544 <td>
 545                 <p>
 546                   The WebSocket close frame payload was not valid utf8.
 547                 </p>
 548                 <p>
 549                   Error codes with this value will compare equal to @ref condition::protocol_violation
 550                 </p>
 551               </td>
 552 </tr>
 553 </tbody>
 554 </table></div>
 555 <h5>
 556 <a name="beast.ref.boost__beast__websocket__error.h2"></a>
 557         <span class="phrase"><a name="beast.ref.boost__beast__websocket__error.description"></a></span><a class="link" href="boost__beast__websocket__error.html#beast.ref.boost__beast__websocket__error.description">Description</a>
 558       </h5>
 559 <p>
 560         Convenience header <code class="literal">&lt;<a href="../../../../../../boost/beast/websocket.hpp" target="_top">boost/beast/websocket.hpp</a>&gt;</code>
 561       </p>
 562 </div>
 563 <table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
 564 <td align="left"></td>
 565 <td align="right"><div class="copyright-footer">Copyright &#169; 2016-2019 Vinnie
 566       Falco<p>
 567         Distributed under the Boost Software License, Version 1.0. (See accompanying
 568         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>)
 569       </p>
 570 </div></td>
 571 </tr></table>
 572 <hr>
 573 <div class="spirit-nav">
 574 <a accesskey="p" href="boost__beast__websocket__condition.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__websocket__frame_type.html"><img src="../../../../../../doc/src/images/next.png" alt="Next"></a>
 575 </div>
 576 </body>
 577 </html>