NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: 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 
33 
36 
37 #include <map>
38 #include <string>
39 #include <utility>
40 
41 namespace websocketpp {
42 namespace extensions {
43 namespace permessage_deflate {
44 
46 
51 template <typename config>
52 class disabled {
53  typedef std::pair<lib::error_code,std::string> err_str_pair;
54 
55 public:
57 
64  err_str_pair negotiate(http::attribute_list const &) {
65  return make_pair(make_error_code(error::disabled),std::string());
66  }
67 
69 
75  lib::error_code init(bool) {
76  return lib::error_code();
77  }
78 
81  bool is_implemented() const {
82  return false;
83  }
84 
87  bool is_enabled() const {
88  return false;
89  }
90 
92 
98  std::string generate_offer() const {
99  return "";
100  }
101 
103 
108  lib::error_code compress(std::string const &, std::string &) {
110  }
111 
113 
119  lib::error_code decompress(uint8_t const *, size_t, std::string &) {
121  }
122 };
123 
124 } // namespace permessage_deflate
125 } // namespace extensions
126 } // namespace websocketpp
127 
128 #endif // WEBSOCKETPP_EXTENSION_PERMESSAGE_DEFLATE_DISABLED_HPP
lib::error_code init(bool)
Initialize state.
Definition: disabled.hpp:75
lib::error_code make_error_code(error::value e)
Definition: error.hpp:235
bool is_enabled() const
Returns true if permessage_deflate functionality is active for this connection.
Definition: disabled.hpp:87
Stub class for use when disabling permessage_deflate extension.
Definition: disabled.hpp:52
err_str_pair negotiate(http::attribute_list const &)
Negotiate extension.
Definition: disabled.hpp:64
lib::error_code compress(std::string const &, std::string &)
Compress bytes.
Definition: disabled.hpp:108
lib::error_code decompress(uint8_t const *, size_t, std::string &)
Decompress bytes.
Definition: disabled.hpp:119
bool is_implemented() const
Returns true if the extension is capable of providing permessage_deflate functionality.
Definition: disabled.hpp:81
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
std::string generate_offer() const
Generate extension offer.
Definition: disabled.hpp:98