2 * Copyright (c) 2014, Peter Thorson. All rights reserved.
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.
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.
28 #ifndef WEBSOCKETPP_EXTENSION_HPP
29 #define WEBSOCKETPP_EXTENSION_HPP
31 #include <websocketpp/common/cpp11.hpp>
32 #include <websocketpp/common/system_error.hpp>
37 namespace websocketpp {
40 * Some generic information about extensions
42 * Each extension object has an implemented flag. It can be retrieved by calling
43 * is_implemented(). This compile time flag indicates whether or not the object
44 * in question actually implements the extension or if it is a placeholder stub
46 * Each extension object also has an enabled flag. It can be retrieved by
47 * calling is_enabled(). This runtime flag indicates whether or not the
48 * extension has been negotiated for this connection.
50 namespace extensions {
57 /// Extension disabled
61 class category : public lib::error_category {
65 const char *name() const _WEBSOCKETPP_NOEXCEPT_TOKEN_ {
66 return "websocketpp.extension";
69 std::string message(int value) const {
72 return "Generic extension error";
74 return "Use of methods from disabled extension";
76 return "Unknown permessage-compress error";
81 inline lib::error_category const & get_category() {
82 static category instance;
86 inline lib::error_code make_error_code(error::value e) {
87 return lib::error_code(static_cast<int>(e), get_category());
91 } // namespace extensions
92 } // namespace websocketpp
94 _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
95 template<> struct is_error_code_enum
96 <websocketpp::extensions::error::value>
98 static const bool value = true;
100 _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
102 #endif // WEBSOCKETPP_EXTENSION_HPP