WebSocket++  0.7.0
C++ websocket client/server library
core.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_CONFIG_CORE_HPP
29 #define WEBSOCKETPP_CONFIG_CORE_HPP
30 
31 // Non-Policy common stuff
32 #include <websocketpp/common/platforms.hpp>
33 #include <websocketpp/common/cpp11.hpp>
34 #include <websocketpp/common/stdint.hpp>
35 
36 // Concurrency
37 #include <websocketpp/concurrency/basic.hpp>
38 
39 // Transport
40 #include <websocketpp/transport/iostream/endpoint.hpp>
41 
42 // HTTP
43 #include <websocketpp/http/request.hpp>
44 #include <websocketpp/http/response.hpp>
45 
46 // Messages
47 #include <websocketpp/message_buffer/message.hpp>
48 #include <websocketpp/message_buffer/alloc.hpp>
49 
50 // Loggers
51 #include <websocketpp/logger/basic.hpp>
52 
53 // RNG
54 #include <websocketpp/random/none.hpp>
55 
56 // User stub base classes
57 #include <websocketpp/endpoint_base.hpp>
58 #include <websocketpp/connection_base.hpp>
59 
60 // Extensions
61 #include <websocketpp/extensions/permessage_deflate/disabled.hpp>
62 
63 namespace websocketpp {
64 namespace config {
65 
67 struct core {
68  typedef core type;
69 
70  // Concurrency policy
72 
73  // HTTP Parser Policies
76 
77  // Message Policies
84 
86  typedef websocketpp::log::basic<concurrency_type,
88  typedef websocketpp::log::basic<concurrency_type,
90 
93 
97  static bool const enable_multithreading = true;
98 
100  typedef type::concurrency_type concurrency_type;
101  typedef type::elog_type elog_type;
102  typedef type::alog_type alog_type;
103  typedef type::request_type request_type;
104  typedef type::response_type response_type;
105 
109  static bool const enable_multithreading = true;
110 
112 
114 
117  static const long timeout_socket_pre_init = 5000;
118 
120  static const long timeout_proxy = 5000;
121 
123 
127  static const long timeout_socket_post_init = 5000;
128 
130  static const long timeout_dns_resolve = 5000;
131 
133  static const long timeout_connect = 5000;
134 
136  static const long timeout_socket_shutdown = 5000;
137  };
138 
142 
147 
149 
151  static const long timeout_open_handshake = 5000;
153  static const long timeout_close_handshake = 5000;
155  static const long timeout_pong = 5000;
156 
158 
163  static const int client_version = 13; // RFC6455
164 
166 
175  static const websocketpp::log::level elog_level =
177 
179 
188  static const websocketpp::log::level alog_level =
190 
192  static const size_t connection_read_buffer_size = 16384;
193 
195 
201  static const bool drop_on_protocol_error = false;
202 
204 
216  static const bool silent_close = false;
217 
219 
228  static const size_t max_message_size = 32000000;
229 
231 
240  static const size_t max_http_body_size = 32000000;
241 
243  static const bool enable_extensions = true;
244 
246 
249  typedef core::request_type request_type;
250 
253  static const bool allow_disabling_context_takeover = true;
254 
260  static const uint8_t minimum_outgoing_window_bits = 8;
261  };
262 
265 
267 
279  //static const bool autonegotiate_compression = false;
280 };
281 
282 } // namespace config
283 } // namespace websocketpp
284 
285 #endif // WEBSOCKETPP_CONFIG_CORE_HPP
static level const all
Special aggregate value representing "all levels".
Definition: levels.hpp:152
static bool const enable_multithreading
Definition: core.hpp:97
static const size_t max_http_body_size
Default maximum http body size.
Definition: core.hpp:240
static const long timeout_pong
Length of time to wait for a pong after a ping.
Definition: core.hpp:155
static const bool enable_extensions
Global flag for enabling/disabling extensions.
Definition: core.hpp:243
websocketpp::random::none::int_generator< uint32_t > rng_type
RNG policies.
Definition: core.hpp:92
Concurrency policy that uses std::mutex / boost::mutex.
Definition: basic.hpp:37
static const long timeout_socket_pre_init
Default timer values (in ms)
Definition: core.hpp:117
static level const devel
Low level debugging information (warning: very chatty)
Definition: levels.hpp:63
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
Definition: core.hpp:153
websocketpp::connection_base connection_base
User overridable Connection base class.
Definition: core.hpp:146
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
Definition: core.hpp:120
Package of log levels for logging access events.
Definition: levels.hpp:112
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition: core.hpp:87
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 long timeout_socket_post_init
Length of time to wait for socket post-initialization.
Definition: core.hpp:127
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
Definition: core.hpp:141
static const long timeout_open_handshake
Default timer values (in ms)
Definition: core.hpp:151
Stub for user supplied base class.
Basic logger that outputs to an ostream.
Definition: basic.hpp:59
Stub for user supplied base class.
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
Definition: core.hpp:201
Thread safe stub "random" integer generator.
Definition: none.hpp:46
Namespace for the WebSocket++ project.
Definition: base64.hpp:41
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
Definition: core.hpp:130
Represents a buffer for a single WebSocket message.
Definition: message.hpp:84
static const bool silent_close
Suppresses the return of detailed connection close information.
Definition: core.hpp:216
static const int client_version
WebSocket Protocol version to use as a client.
Definition: core.hpp:163
static const websocketpp::log::level elog_level
Default static error logging channels.
Definition: core.hpp:175
static const websocketpp::log::level alog_level
Default static access logging channels.
Definition: core.hpp:188
Package of log levels for logging errors.
Definition: levels.hpp:59
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
Definition: core.hpp:136
websocketpp::endpoint_base endpoint_base
User overridable Endpoint base class.
Definition: core.hpp:144
Stores, parses, and manipulates HTTP requests.
Definition: request.hpp:50
static const long timeout_connect
Length of time to wait for TCP connect.
Definition: core.hpp:133
static level const all
Special aggregate value representing "all levels".
Definition: levels.hpp:80
Server config with iostream transport.
Definition: core.hpp:67
static const size_t max_message_size
Default maximum message size.
Definition: core.hpp:228