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