error.ipp 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  1. //
  2. // Copyright (c) 2016-2019 Vinnie Falco (vinnie dot falco at gmail dot com)
  3. //
  4. // Distributed under the Boost Software License, Version 1.0. (See accompanying
  5. // file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
  6. //
  7. // Official repository: https://github.com/boostorg/beast
  8. //
  9. #ifndef BOOST_BEAST_WEBSOCKET_IMPL_ERROR_IPP
  10. #define BOOST_BEAST_WEBSOCKET_IMPL_ERROR_IPP
  11. #include <boost/beast/websocket/error.hpp>
  12. namespace boost {
  13. namespace beast {
  14. namespace websocket {
  15. namespace detail {
  16. class error_codes : public error_category
  17. {
  18. public:
  19. const char*
  20. name() const noexcept override
  21. {
  22. return "boost.beast.websocket";
  23. }
  24. std::string
  25. message(int ev) const override
  26. {
  27. switch(static_cast<error>(ev))
  28. {
  29. default:
  30. case error::closed: return "The WebSocket stream was gracefully closed at both endpoints";
  31. case error::buffer_overflow: return "The WebSocket operation caused a dynamic buffer overflow";
  32. case error::partial_deflate_block: return "The WebSocket stream produced an incomplete deflate block";
  33. case error::message_too_big: return "The WebSocket message exceeded the locally configured limit";
  34. case error::bad_http_version: return "The WebSocket handshake was not HTTP/1.1";
  35. case error::bad_method: return "The WebSocket handshake method was not GET";
  36. case error::no_host: return "The WebSocket handshake Host field is missing";
  37. case error::no_connection: return "The WebSocket handshake Connection field is missing";
  38. case error::no_connection_upgrade: return "The WebSocket handshake Connection field is missing the upgrade token";
  39. case error::no_upgrade: return "The WebSocket handshake Upgrade field is missing";
  40. case error::no_upgrade_websocket: return "The WebSocket handshake Upgrade field is missing the websocket token";
  41. case error::no_sec_key: return "The WebSocket handshake Sec-WebSocket-Key field is missing";
  42. case error::bad_sec_key: return "The WebSocket handshake Sec-WebSocket-Key field is invalid";
  43. case error::no_sec_version: return "The WebSocket handshake Sec-WebSocket-Version field is missing";
  44. case error::bad_sec_version: return "The WebSocket handshake Sec-WebSocket-Version field is invalid";
  45. case error::no_sec_accept: return "The WebSocket handshake Sec-WebSocket-Accept field is missing";
  46. case error::bad_sec_accept: return "The WebSocket handshake Sec-WebSocket-Accept field is invalid";
  47. case error::upgrade_declined: return "The WebSocket handshake was declined by the remote peer";
  48. case error::bad_opcode: return "The WebSocket frame contained an illegal opcode";
  49. case error::bad_data_frame: return "The WebSocket data frame was unexpected";
  50. case error::bad_continuation: return "The WebSocket continuation frame was unexpected";
  51. case error::bad_reserved_bits: return "The WebSocket frame contained illegal reserved bits";
  52. case error::bad_control_fragment: return "The WebSocket control frame was fragmented";
  53. case error::bad_control_size: return "The WebSocket control frame size was invalid";
  54. case error::bad_unmasked_frame: return "The WebSocket frame was unmasked";
  55. case error::bad_masked_frame: return "The WebSocket frame was masked";
  56. case error::bad_size: return "The WebSocket frame size was not canonical";
  57. case error::bad_frame_payload: return "The WebSocket frame payload was not valid utf8";
  58. case error::bad_close_code: return "The WebSocket close frame reason code was invalid";
  59. case error::bad_close_size: return "The WebSocket close frame payload size was invalid";
  60. case error::bad_close_payload: return "The WebSocket close frame payload was not valid utf8";
  61. }
  62. }
  63. error_condition
  64. default_error_condition(int ev) const noexcept override
  65. {
  66. switch(static_cast<error>(ev))
  67. {
  68. default:
  69. case error::closed:
  70. case error::buffer_overflow:
  71. case error::partial_deflate_block:
  72. case error::message_too_big:
  73. return {ev, *this};
  74. case error::bad_http_version:
  75. case error::bad_method:
  76. case error::no_host:
  77. case error::no_connection:
  78. case error::no_connection_upgrade:
  79. case error::no_upgrade:
  80. case error::no_upgrade_websocket:
  81. case error::no_sec_key:
  82. case error::bad_sec_key:
  83. case error::no_sec_version:
  84. case error::bad_sec_version:
  85. case error::no_sec_accept:
  86. case error::bad_sec_accept:
  87. case error::upgrade_declined:
  88. return condition::handshake_failed;
  89. case error::bad_opcode:
  90. case error::bad_data_frame:
  91. case error::bad_continuation:
  92. case error::bad_reserved_bits:
  93. case error::bad_control_fragment:
  94. case error::bad_control_size:
  95. case error::bad_unmasked_frame:
  96. case error::bad_masked_frame:
  97. case error::bad_size:
  98. case error::bad_frame_payload:
  99. case error::bad_close_code:
  100. case error::bad_close_size:
  101. case error::bad_close_payload:
  102. return condition::protocol_violation;
  103. }
  104. }
  105. };
  106. class error_conditions : public error_category
  107. {
  108. public:
  109. const char*
  110. name() const noexcept override
  111. {
  112. return "boost.beast.websocket";
  113. }
  114. std::string
  115. message(int cv) const override
  116. {
  117. switch(static_cast<condition>(cv))
  118. {
  119. default:
  120. case condition::handshake_failed: return "The WebSocket handshake failed";
  121. case condition::protocol_violation: return "A WebSocket protocol violation occurred";
  122. }
  123. }
  124. };
  125. } // detail
  126. error_code
  127. make_error_code(error e)
  128. {
  129. static detail::error_codes const cat{};
  130. return error_code{static_cast<
  131. std::underlying_type<error>::type>(e), cat};
  132. }
  133. error_condition
  134. make_error_condition(condition c)
  135. {
  136. static detail::error_conditions const cat{};
  137. return error_condition{static_cast<
  138. std::underlying_type<condition>::type>(c), cat};
  139. }
  140. } // websocket
  141. } // beast
  142. } // boost
  143. #endif