NS-3 based Named Data Networking (NDN) simulator
ndnSIM 2.3: NDN, CCN, CCNx, content centric networks
API Documentation
core_client.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_CONFIG_CORE_CLIENT_HPP
29 #define WEBSOCKETPP_CONFIG_CORE_CLIENT_HPP
30 
31 // Non-Policy common stuff
35 
36 // Concurrency
37 #ifndef _WEBSOCKETPP_NO_THREADING_
39 #else
41 #endif
42 
43 // Transport
45 
46 // HTTP
49 
50 // Messages
53 
54 // Loggers
56 
57 // RNG
59 
60 // User stub base classes
63 
64 // Extensions
66 
67 namespace websocketpp {
68 namespace config {
69 
71 struct core_client {
72  typedef core_client type;
73 
74  // Concurrency policy
75 #ifndef _WEBSOCKETPP_NO_THREADING_
77 #else
79 #endif
80 
81  // HTTP Parser Policies
84 
85  // Message Policies
92 
98 
101  concurrency_type> rng_type;
102 
106  static bool const enable_multithreading = true;
107 
114 
118  static bool const enable_multithreading = true;
119 
121 
123 
126  static const long timeout_socket_pre_init = 5000;
127 
129  static const long timeout_proxy = 5000;
130 
132 
136  static const long timeout_socket_post_init = 5000;
137 
139  static const long timeout_dns_resolve = 5000;
140 
142  static const long timeout_connect = 5000;
143 
145  static const long timeout_socket_shutdown = 5000;
146  };
147 
151 
156 
158 
160  static const long timeout_open_handshake = 5000;
162  static const long timeout_close_handshake = 5000;
164  static const long timeout_pong = 5000;
165 
167 
172  static const int client_version = 13; // RFC6455
173 
175 
186 
188 
199 
201  static const size_t connection_read_buffer_size = 16384;
202 
204 
210  static const bool drop_on_protocol_error = false;
211 
213 
225  static const bool silent_close = false;
226 
228 
237  static const size_t max_message_size = 32000000;
238 
240 
249  static const size_t max_http_body_size = 32000000;
250 
252  static const bool enable_extensions = true;
253 
255 
259 
262  static const bool allow_disabling_context_takeover = true;
263 
269  static const uint8_t minimum_outgoing_window_bits = 8;
270  };
271 
274 
276 
288  //static const bool autonegotiate_compression = false;
289 };
290 
291 } // namespace config
292 } // namespace websocketpp
293 
294 #endif // WEBSOCKETPP_CONFIG_CORE_CLIENT_HPP
static level const all
Special aggregate value representing "all levels".
Definition: levels.hpp:152
static const long timeout_open_handshake
Default timer values (in ms)
static const long timeout_pong
Length of time to wait for a pong after a ping.
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
message_buffer::alloc::endpoint_msg_manager< con_msg_manager_type > endpoint_msg_manager_type
Definition: core_client.hpp:91
Concurrency policy that uses std::mutex / boost::mutex.
Definition: basic.hpp:37
websocketpp::log::basic< concurrency_type, websocketpp::log::alevel > alog_type
Definition: core_client.hpp:97
static level const devel
Low level debugging information (warning: very chatty)
Definition: levels.hpp:63
static const websocketpp::log::level alog_level
Default static access logging channels.
websocketpp::concurrency::basic concurrency_type
Definition: core_client.hpp:76
static bool const enable_multithreading
Controls compile time enabling/disabling of thread syncronization code Disabling can provide a minor ...
static const long timeout_connect
Length of time to wait for TCP connect.
Package of log levels for logging access events.
Definition: levels.hpp:112
Stores, parses, and manipulates HTTP responses.
Definition: response.hpp:57
static level const devel
Development messages (warning: very chatty)
Definition: levels.hpp:141
Stub class for use when disabling permessage_deflate extension.
Definition: disabled.hpp:52
static const int client_version
WebSocket Protocol version to use as a client.
http::parser::request request_type
Definition: core_client.hpp:82
websocketpp::endpoint_base endpoint_base
User overridable Endpoint base class.
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
static const long timeout_socket_pre_init
Default timer values (in ms)
Stub for user supplied base class.
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
static const websocketpp::log::level elog_level
Default static error logging channels.
message_buffer::alloc::con_msg_manager< message_type > con_msg_manager_type
Definition: core_client.hpp:89
Basic logger that outputs to an ostream.
Definition: basic.hpp:59
static const bool enable_extensions
Global flag for enabling/disabling extensions.
websocketpp::extensions::permessage_deflate::disabled< permessage_deflate_config > permessage_deflate_type
Stub for user supplied base class.
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
http::parser::response response_type
Definition: core_client.hpp:83
Represents a buffer for a single WebSocket message.
Definition: message.hpp:84
Stub concurrency policy that implements the interface using no-ops.
Definition: none.hpp:60
static const size_t connection_read_buffer_size
static const size_t max_http_body_size
Default maximum http body size.
websocketpp::random::random_device::int_generator< uint32_t, concurrency_type > rng_type
RNG policies.
websocketpp::connection_base connection_base
User overridable Connection base class.
Package of log levels for logging errors.
Definition: levels.hpp:59
Thread safe non-deterministic random integer generator.
Stores, parses, and manipulates HTTP requests.
Definition: request.hpp:50
static const long timeout_socket_post_init
Length of time to wait for socket post-initialization.
message_buffer::message< message_buffer::alloc::con_msg_manager > message_type
Definition: core_client.hpp:87
static const bool silent_close
Suppresses the return of detailed connection close information.
uint32_t level
Type of a channel package.
Definition: levels.hpp:37
A connection message manager that allocates a new message for each request.
Definition: alloc.hpp:41
static const size_t max_message_size
Default maximum message size.
An endpoint message manager that allocates a new manager for each connection.
Definition: alloc.hpp:88
static level const all
Special aggregate value representing "all levels".
Definition: levels.hpp:80
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
Client config with iostream transport.
Definition: core_client.hpp:71
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition: core_client.hpp:95