WebSocket++  0.8.3-dev
C++ websocket client/server library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
disabled.hpp
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_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP
29 #define WEBSOCKETPP_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP
30 
31 #include <websocketpp/common/cpp11.hpp>
32 #include <websocketpp/common/stdint.hpp>
33 #include <websocketpp/common/system_error.hpp>
34 
35 #include <websocketpp/http/constants.hpp>
36 #include <websocketpp/extensions/extension.hpp>
37 
38 #include <map>
39 #include <string>
40 #include <utility>
41 
42 namespace websocketpp {
43 namespace extensions {
44 namespace permessage_deflate {
45 
46 /// Stub class for use when disabling permessage_deflate extension
47 /**
48  * This class is a stub that implements the permessage_deflate interface
49  * with minimal dependencies. It is used to disable permessage_deflate
50  * functionality at compile time without loading any unnecessary code.
51  */
52 template <typename config>
53 class disabled {
54  typedef std::pair<lib::error_code,std::string> err_str_pair;
55 
56 public:
57  /// Negotiate extension
58  /**
59  * The disabled extension always fails the negotiation with a disabled
60  * error.
61  *
62  * @param offer Attribute from client's offer
63  * @return Status code and value to return to remote endpoint
64  */
65  err_str_pair negotiate(http::attribute_list const &) {
66  return make_pair(make_error_code(error::disabled),std::string());
67  }
68 
69  /// Initialize state
70  /**
71  * For the disabled extension state initialization is a no-op.
72  *
73  * @param is_server True to initialize as a server, false for a client.
74  * @return A code representing the error that occurred, if any
75  */
76  lib::error_code init(bool) {
77  return lib::error_code();
78  }
79 
80  /// Returns true if the extension is capable of providing
81  /// permessage_deflate functionality
82  bool is_implemented() const {
83  return false;
84  }
85 
86  /// Returns true if permessage_deflate functionality is active for this
87  /// connection
88  bool is_enabled() const {
89  return false;
90  }
91 
92  /// Generate extension offer
93  /**
94  * Creates an offer string to include in the Sec-WebSocket-Extensions
95  * header of outgoing client requests.
96  *
97  * @return A WebSocket extension offer string for this extension
98  */
100  return "";
101  }
102 
103  /// Compress bytes
104  /**
105  * @param [in] in String to compress
106  * @param [out] out String to append compressed bytes to
107  * @return Error or status code
108  */
110  return make_error_code(error::disabled);
111  }
112 
113  /// Decompress bytes
114  /**
115  * @param buf Byte buffer to decompress
116  * @param len Length of buf
117  * @param out String to append decompressed bytes to
118  * @return Error or status code
119  */
121  return make_error_code(error::disabled);
122  }
123 };
124 
125 } // namespace permessage_deflate
126 } // namespace extensions
127 } // namespace websocketpp
128 
129 #endif // WEBSOCKETPP_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP
websocketpp::extensions::permessage_deflate::disabled::compress
lib::error_code compress(std::string const &, std::string &)
Compress bytes.
Definition: disabled.hpp:109
websocketpp::extensions::permessage_deflate::disabled::is_enabled
bool is_enabled() const
Definition: disabled.hpp:88
websocketpp::extensions::permessage_deflate::disabled::decompress
lib::error_code decompress(uint8_t const *, size_t, std::string &)
Decompress bytes.
Definition: disabled.hpp:120
websocketpp::extensions
Definition: extension.hpp:50
websocketpp::extensions::permessage_deflate::disabled::init
lib::error_code init(bool)
Initialize state.
Definition: disabled.hpp:76
websocketpp::versions_supported
static std::vector< int > const versions_supported(helper, helper+4)
Container that stores the list of protocol versions supported.
websocketpp::extensions::permessage_deflate::disabled::generate_offer
std::string generate_offer() const
Generate extension offer.
Definition: disabled.hpp:99
websocketpp::extensions::permessage_deflate::disabled::negotiate
err_str_pair negotiate(http::attribute_list const &)
Negotiate extension.
Definition: disabled.hpp:65
websocketpp::extensions::permessage_deflate::disabled::is_implemented
bool is_implemented() const
Definition: disabled.hpp:82
websocketpp::extensions::permessage_deflate
Implementation of RFC 7692, the permessage-deflate WebSocket extension.
Definition: disabled.hpp:44
websocketpp::extensions::permessage_deflate::disabled
Stub class for use when disabling permessage_deflate extension.
Definition: disabled.hpp:53