NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
error.hpp
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2014, Peter Thorson. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are met:
6  * * Redistributions of source code must retain the above copyright
7  * notice, this list of conditions and the following disclaimer.
8  * * Redistributions in binary form must reproduce the above copyright
9  * notice, this list of conditions and the following disclaimer in the
10  * documentation and/or other materials provided with the distribution.
11  * * Neither the name of the WebSocket++ Project nor the
12  * names of its contributors may be used to endorse or promote products
13  * derived from this software without specific prior written permission.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
16  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED. IN NO EVENT SHALL PETER THORSON BE LIABLE FOR ANY
19  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
20  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
21  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
22  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
24  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  */
27 
28 #ifndef WEBSOCKETPP_ERROR_HPP
29 #define WEBSOCKETPP_ERROR_HPP
30 
31 #include <exception>
32 #include <string>
33 #include <utility>
34 
37 
38 namespace websocketpp {
39 
41 typedef std::pair<lib::error_code,std::string> err_str_pair;
42 
44 namespace error {
45 enum value {
47  general = 1,
48 
51 
55 
58 
63 
66 
69 
72 
75 
78 
81 
84 
87 
90 
94 
97 
100 
103 
106 
109 
112 
115 
118 
121 
125 
128 
131 
135 
138 
141 
144 
147 }; // enum value
148 
149 
150 class category : public lib::error_category {
151 public:
152  category() {}
153 
154  char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
155  return "websocketpp";
156  }
157 
158  std::string message(int value) const {
159  switch(value) {
160  case error::general:
161  return "Generic error";
163  return "send queue full";
165  return "payload violation";
167  return "endpoint not secure";
169  return "endpoint not available";
170  case error::invalid_uri:
171  return "invalid uri";
173  return "no outgoing message buffers";
175  return "no incoming message buffers";
177  return "invalid state";
179  return "Unable to extract close code";
181  return "Extracted close code is in an invalid range";
183  return "Extracted close code is in a reserved range";
184  case error::invalid_utf8:
185  return "Invalid UTF-8";
187  return "Invalid subprotocol";
189  return "Bad Connection";
190  case error::test:
191  return "Test Error";
193  return "Connection creation attempt failed";
195  return "Selected subprotocol was not requested by the client";
196  case error::client_only:
197  return "Feature not available on server endpoints";
198  case error::server_only:
199  return "Feature not available on client endpoints";
201  return "HTTP connection ended";
203  return "The opening handshake timed out";
205  return "The closing handshake timed out";
206  case error::invalid_port:
207  return "Invalid URI port";
209  return "Async Accept not listening";
211  return "Operation canceled";
212  case error::rejected:
213  return "Connection rejected";
215  return "Upgrade required";
217  return "Invalid version";
219  return "Unsupported version";
221  return "HTTP parse error";
223  return "Extension negotiation failed";
224  default:
225  return "Unknown";
226  }
227  }
228 };
229 
230 inline const lib::error_category& get_category() {
231  static category instance;
232  return instance;
233 }
234 
235 inline lib::error_code make_error_code(error::value e) {
236  return lib::error_code(static_cast<int>(e), get_category());
237 }
238 
239 } // namespace error
240 } // namespace websocketpp
241 
243 template<> struct is_error_code_enum<websocketpp::error::value>
244 {
245  static bool const value = true;
246 };
248 
249 namespace websocketpp {
250 
251 class exception : public std::exception {
252 public:
253  exception(std::string const & msg, lib::error_code ec = make_error_code(error::general))
254  : m_msg(msg.empty() ? ec.message() : msg), m_code(ec)
255  {}
256 
257  explicit exception(lib::error_code ec)
258  : m_msg(ec.message()), m_code(ec)
259  {}
260 
261  ~exception() throw() {}
262 
263  virtual char const * what() const throw() {
264  return m_msg.c_str();
265  }
266 
267  lib::error_code code() const throw() {
268  return m_code;
269  }
270 
271  const std::string m_msg;
272  lib::error_code m_code;
273 };
274 
275 } // namespace websocketpp
276 
277 #endif // WEBSOCKETPP_ERROR_HPP
std::string message(int value) const
Definition: error.hpp:158
lib::error_code make_error_code(error::value e)
Definition: error.hpp:235
Attempted to use a client specific feature on a server endpoint.
Definition: error.hpp:105
std::pair< lib::error_code, std::string > err_str_pair
Combination error code / string type for returning two values.
Definition: error.hpp:41
#define _WEBSOCKETPP_NOEXCEPT_TOKEN_
Definition: cpp11.hpp:113
Connection rejected.
Definition: error.hpp:130
Selected subprotocol was not requested by the client.
Definition: error.hpp:102
Attempted an operation that required an endpoint that is no longer available.
Definition: error.hpp:62
Invalid port in URI.
Definition: error.hpp:120
Close code is invalid.
Definition: error.hpp:83
exception(std::string const &msg, lib::error_code ec=make_error_code(error::general))
Definition: error.hpp:253
Unable to parse close code.
Definition: error.hpp:77
exception(lib::error_code ec)
Definition: error.hpp:257
lib::error_code code() const
Definition: error.hpp:267
Close code is in a reserved range.
Definition: error.hpp:80
Invalid WebSocket protocol version.
Definition: error.hpp:137
lib::error_code m_code
Definition: error.hpp:272
An operation was attempted on a connection that did not exist or was already deleted.
Definition: error.hpp:93
The connection was in the wrong state for this operation.
Definition: error.hpp:74
char const * name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_
Definition: error.hpp:154
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
The requested operation was canceled.
Definition: error.hpp:127
An async accept operation failed because the underlying transport has been requested to not listen fo...
Definition: error.hpp:124
Extension negotiation failed.
Definition: error.hpp:146
The endpoint is out of incoming message buffers.
Definition: error.hpp:71
send attempted when endpoint write queue was full
Definition: error.hpp:50
The endpoint is out of outgoing message buffers.
Definition: error.hpp:68
WebSocket close handshake timed out.
Definition: error.hpp:117
Catch-all library error.
Definition: error.hpp:47
const std::string m_msg
Definition: error.hpp:271
WebSocket opening handshake timed out.
Definition: error.hpp:114
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
virtual char const * what() const
Definition: error.hpp:263
Attempted to use a server specific feature on a client endpoint.
Definition: error.hpp:108
Attempted to open a secure connection with an insecure endpoint.
Definition: error.hpp:57
const lib::error_category & get_category()
Definition: error.hpp:230
Unit testing utility error code.
Definition: error.hpp:96
Attempted an operation using a payload that was improperly formatted ex: invalid UTF8 encoding on a t...
Definition: error.hpp:54
An invalid uri was supplied.
Definition: error.hpp:65
Unsupported WebSocket protocol version.
Definition: error.hpp:140
Connection creation attempted failed.
Definition: error.hpp:99