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
10#ifndef BOOST_BEAST_WEBSOCKET_IMPL_ERROR_IPP
11#define BOOST_BEAST_WEBSOCKET_IMPL_ERROR_IPP
12
13#include <boost/beast/websocket/error.hpp>
14
15namespace boost {
16namespace beast {
17namespace websocket {
18namespace detail {
19
20class error_codes : public error_category
21{
22public:
23
24 error_codes() : error_category(0x065d7edd7687edafu ) {}
25
26 const char*
27 name() const noexcept override
28 {
29 return "boost.beast.websocket";
30 }
31
32 BOOST_BEAST_DECL
33 char const*
34 message(int ev, char*, std::size_t) const noexcept override
35 {
36 switch(static_cast<error>(ev))
37 {
38 default:
39 case error::closed: return "The WebSocket stream was gracefully closed at both endpoints";
40 case error::buffer_overflow: return "The WebSocket operation caused a dynamic buffer overflow";
41 case error::partial_deflate_block: return "The WebSocket stream produced an incomplete deflate block";
42 case error::message_too_big: return "The WebSocket message exceeded the locally configured limit";
43
44 case error::bad_http_version: return "The WebSocket handshake was not HTTP/1.1";
45 case error::bad_method: return "The WebSocket handshake method was not GET";
46 case error::no_host: return "The WebSocket handshake Host field is missing";
47 case error::no_connection: return "The WebSocket handshake Connection field is missing";
48 case error::no_connection_upgrade: return "The WebSocket handshake Connection field is missing the upgrade token";
49 case error::no_upgrade: return "The WebSocket handshake Upgrade field is missing";
50 case error::no_upgrade_websocket: return "The WebSocket handshake Upgrade field is missing the websocket token";
51 case error::no_sec_key: return "The WebSocket handshake Sec-WebSocket-Key field is missing";
52 case error::bad_sec_key: return "The WebSocket handshake Sec-WebSocket-Key field is invalid";
53 case error::no_sec_version: return "The WebSocket handshake Sec-WebSocket-Version field is missing";
54 case error::bad_sec_version: return "The WebSocket handshake Sec-WebSocket-Version field is invalid";
55 case error::no_sec_accept: return "The WebSocket handshake Sec-WebSocket-Accept field is missing";
56 case error::bad_sec_accept: return "The WebSocket handshake Sec-WebSocket-Accept field is invalid";
57 case error::upgrade_declined: return "The WebSocket handshake was declined by the remote peer";
58
59 case error::bad_opcode: return "The WebSocket frame contained an illegal opcode";
60 case error::bad_data_frame: return "The WebSocket data frame was unexpected";
61 case error::bad_continuation: return "The WebSocket continuation frame was unexpected";
62 case error::bad_reserved_bits: return "The WebSocket frame contained illegal reserved bits";
63 case error::bad_control_fragment: return "The WebSocket control frame was fragmented";
64 case error::bad_control_size: return "The WebSocket control frame size was invalid";
65 case error::bad_unmasked_frame: return "The WebSocket frame was unmasked";
66 case error::bad_masked_frame: return "The WebSocket frame was masked";
67 case error::bad_size: return "The WebSocket frame size was not canonical";
68 case error::bad_frame_payload: return "The WebSocket frame payload was not valid utf8";
69 case error::bad_close_code: return "The WebSocket close frame reason code was invalid";
70 case error::bad_close_size: return "The WebSocket close frame payload size was invalid";
71 case error::bad_close_payload: return "The WebSocket close frame payload was not valid utf8";
72 }
73 }
74
75 std::string
76 message(int ev) const override
77 {
78 return message(ev, nullptr, 0);
79 }
80
81 error_condition
82 default_error_condition(int ev) const noexcept override
83 {
84 switch(static_cast<error>(ev))
85 {
86 default:
87 case error::closed:
88 case error::buffer_overflow:
89 case error::partial_deflate_block:
90 case error::message_too_big:
91 return {ev, *this};
92
93 case error::bad_http_version:
94 case error::bad_method:
95 case error::no_host:
96 case error::no_connection:
97 case error::no_connection_upgrade:
98 case error::no_upgrade:
99 case error::no_upgrade_websocket:
100 case error::no_sec_key:
101 case error::bad_sec_key:
102 case error::no_sec_version:
103 case error::bad_sec_version:
104 case error::no_sec_accept:
105 case error::bad_sec_accept:
106 case error::upgrade_declined:
107 return condition::handshake_failed;
108
109 case error::bad_opcode:
110 case error::bad_data_frame:
111 case error::bad_continuation:
112 case error::bad_reserved_bits:
113 case error::bad_control_fragment:
114 case error::bad_control_size:
115 case error::bad_unmasked_frame:
116 case error::bad_masked_frame:
117 case error::bad_size:
118 case error::bad_frame_payload:
119 case error::bad_close_code:
120 case error::bad_close_size:
121 case error::bad_close_payload:
122 return condition::protocol_violation;
123 }
124 }
125};
126
127class error_conditions : public error_category
128{
129public:
130 const char*
131 name() const noexcept override
132 {
133 return "boost.beast.websocket";
134 }
135
136 error_conditions() : error_category(0x7a8de5d61799ce9eu) {}
137
138 BOOST_BEAST_DECL
139 char const*
140 message(int cv, char*, std::size_t) const noexcept override
141 {
142 switch(static_cast<condition>(cv))
143 {
144 default:
145 case condition::handshake_failed: return "The WebSocket handshake failed";
146 case condition::protocol_violation: return "A WebSocket protocol violation occurred";
147 }
148 }
149
150 std::string
151 message(int cv) const override
152 {
153 return message(cv, nullptr, 0);
154 }
155};
156
157} // detail
158
159error_code
160make_error_code(error e)
161{
162 static detail::error_codes const cat{};
163 return error_code{static_cast<
164 std::underlying_type<error>::type>(e), cat};
165}
166
167error_condition
168make_error_condition(condition c)
169{
170 static detail::error_conditions const cat{};
171 return error_condition{static_cast<
172 std::underlying_type<condition>::type>(c), cat};
173}
174
175} // websocket
176} // beast
177} // boost
178
179#endif
180

source code of boost/libs/beast/include/boost/beast/websocket/impl/error.ipp