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_PERMESSAGE_DEFLATE_DISABLED_HPP
29 #define WEBSOCKETPP_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP
31 #include <websocketpp/common/cpp11.hpp>
32 #include <websocketpp/common/system_error.hpp>
34 #include <websocketpp/http/constants.hpp>
35 #include <websocketpp/extensions/extension.hpp>
41 namespace websocketpp {
42 namespace extensions {
43 namespace permessage_deflate {
45 /// Stub class for use when disabling permessage_deflate extension
47 * This class is a stub that implements the permessage_deflate interface
48 * with minimal dependencies. It is used to disable permessage_deflate
49 * functionality at compile time without loading any unnecessary code.
51 template <typename config>
53 typedef std::pair<lib::error_code,std::string> err_str_pair;
56 /// Negotiate extension
58 * The disabled extension always fails the negotiation with a disabled
61 * @param offer Attribute from client's offer
62 * @return Status code and value to return to remote endpoint
64 err_str_pair negotiate(http::attribute_list const &) {
65 return make_pair(make_error_code(error::disabled),std::string());
70 * For the disabled extension state initialization is a no-op.
72 * @param is_server True to initialize as a server, false for a client.
73 * @return A code representing the error that occurred, if any
75 lib::error_code init(bool) {
76 return lib::error_code();
79 /// Returns true if the extension is capable of providing
80 /// permessage_deflate functionality
81 bool is_implemented() const {
85 /// Returns true if permessage_deflate functionality is active for this
87 bool is_enabled() const {
91 /// Generate extension offer
93 * Creates an offer string to include in the Sec-WebSocket-Extensions
94 * header of outgoing client requests.
96 * @return A WebSocket extension offer string for this extension
98 std::string generate_offer() const {
104 * @param [in] in String to compress
105 * @param [out] out String to append compressed bytes to
106 * @return Error or status code
108 lib::error_code compress(std::string const &, std::string &) {
109 return make_error_code(error::disabled);
114 * @param buf Byte buffer to decompress
115 * @param len Length of buf
116 * @param out String to append decompressed bytes to
117 * @return Error or status code
119 lib::error_code decompress(uint8_t const *, size_t, std::string &) {
120 return make_error_code(error::disabled);
124 } // namespace permessage_deflate
125 } // namespace extensions
126 } // namespace websocketpp
128 #endif // WEBSOCKETPP_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP