NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.5: NDN, CCN, CCNx, content centric networks
API Documentation
disabled.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_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP
29 #define WEBSOCKETPP_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP
30 
34 
37 
38 #include <map>
39 #include <string>
40 #include <utility>
41 
42 namespace websocketpp {
43 namespace extensions {
44 namespace permessage_deflate {
45 
47 
52 template <typename config>
53 class disabled {
54  typedef std::pair<lib::error_code,std::string> err_str_pair;
55 
56 public:
58 
65  err_str_pair negotiate(http::attribute_list const &) {
66  return make_pair(make_error_code(error::disabled),std::string());
67  }
68 
70 
76  lib::error_code init(bool) {
77  return lib::error_code();
78  }
79 
82  bool is_implemented() const {
83  return false;
84  }
85 
88  bool is_enabled() const {
89  return false;
90  }
91 
93 
99  std::string generate_offer() const {
100  return "";
101  }
102 
104 
109  lib::error_code compress(std::string const &, std::string &) {
111  }
112 
114 
120  lib::error_code decompress(uint8_t const *, size_t, std::string &) {
122  }
123 };
124 
125 } // namespace permessage_deflate
126 } // namespace extensions
127 } // namespace websocketpp
128 
129 #endif // WEBSOCKETPP_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP
lib::error_code init(bool)
Initialize state.
Definition: disabled.hpp:76
lib::error_code make_error_code(error::value e)
Definition: error.hpp:235
std::string generate_offer() const
Generate extension offer.
Definition: disabled.hpp:99
Stub class for use when disabling permessage_deflate extension.
Definition: disabled.hpp:53
err_str_pair negotiate(http::attribute_list const &)
Negotiate extension.
Definition: disabled.hpp:65
bool is_implemented() const
Returns true if the extension is capable of providing permessage_deflate functionality.
Definition: disabled.hpp:82
lib::error_code compress(std::string const &, std::string &)
Compress bytes.
Definition: disabled.hpp:109
lib::error_code decompress(uint8_t const *, size_t, std::string &)
Decompress bytes.
Definition: disabled.hpp:120
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
std::map< std::string, std::string > attribute_list
The type of an HTTP attribute list.
Definition: constants.hpp:45
bool is_enabled() const
Returns true if permessage_deflate functionality is active for this connection.
Definition: disabled.hpp:88