WebSocket++  0.8.0-dev
C++ websocket client/server library
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Pages
Public Types | Static Public Attributes | List of all members
websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate > Struct Template Reference

#include <config_builder.hpp>

Inheritance diagram for websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >:

Public Types

typedef builder type
 
typedef
websocketpp::concurrency::basic 
concurrency_type
 
typedef http::parser::request request_type
 
typedef http::parser::response response_type
 
typedef
websocketpp::log::basic
< concurrency_type,
websocketpp::log::elevel
elog_type
 
typedef
websocketpp::log::basic
< concurrency_type,
websocketpp::log::alevel
alog_type
 
typedef
message_buffer::message
< message_buffer::alloc::con_msg_manager
message_type
 
typedef
message_buffer::alloc::con_msg_manager
< message_type
con_msg_manager_type
 
typedef
message_buffer::alloc::endpoint_msg_manager
< con_msg_manager_type
endpoint_msg_manager_type
 
typedef websocketpp::endpoint_base endpoint_base
 User overridable Endpoint base class.
 
typedef
websocketpp::connection_base 
connection_base
 User overridable Connection base class.
 

Static Public Attributes

static bool const enable_multithreading = true
 
static const size_t max_http_body_size = 32000000
 Default maximum http body size. More...
 
static const long timeout_open_handshake = 5000
 Length of time before an opening handshake is aborted (ms)
 
static const long timeout_close_handshake = 5000
 Length of time before a closing handshake is aborted (ms)
 
static const long timeout_pong = 5000
 Length of time to wait for a pong after a ping (ms)
 
static const int client_version = 13
 WebSocket Protocol version to use as a client. More...
 
static const size_t connection_read_buffer_size = 16384
 Connection read buffer. More...
 
static const bool drop_on_protocol_error = false
 Drop connections immediately on protocol error. More...
 
static const bool silent_close = false
 Suppresses the return of detailed connection close information. More...
 
static const size_t max_message_size = 32000000
 Default maximum message size. More...
 
static const bool enable_extensions = true
 Global flag for enabling/disabling extensions.
 

Detailed Description

template<template< typename > typename Role, typename Debug, typename Transport, typename PermessageDeflate = no_compression>
struct websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >

Assumptions:

Definition at line 204 of file config_builder.hpp.

Member Data Documentation

template<template< typename > typename Role, typename Debug , typename Transport , typename PermessageDeflate = no_compression>
const int websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >::client_version = 13
static

WebSocket Protocol version to use as a client.

What version of the WebSocket Protocol to use for outgoing client connections. Setting this to a value other than 13 (RFC6455) is not recommended.

Definition at line 280 of file config_builder.hpp.

template<template< typename > typename Role, typename Debug , typename Transport , typename PermessageDeflate = no_compression>
const size_t websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >::connection_read_buffer_size = 16384
static

Connection read buffer.

Determines the amount of memory dedicated per connection to the read buffer. Smaller values will use less memory but require more CPU to process the buffers more often for large messages.

A message of size N will require N/read_buffer_size trips through the processing handler. There is no performance benefit when N is less than read_buffer_size.

Definition at line 292 of file config_builder.hpp.

template<template< typename > typename Role, typename Debug , typename Transport , typename PermessageDeflate = no_compression>
const bool websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >::drop_on_protocol_error = false
static

Drop connections immediately on protocol error.

Drop connections on protocol error rather than sending a close frame. Off by default. This may result in legit messages near the error being dropped as well. It may free up resources otherwise spent dealing with misbehaving clients.

Definition at line 301 of file config_builder.hpp.

template<template< typename > typename Role, typename Debug , typename Transport , typename PermessageDeflate = no_compression>
bool const websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >::enable_multithreading = true
static

Controls compile time enabling/disabling of thread syncronization code Disabling can provide a minor performance improvement to single threaded applications

Definition at line 213 of file config_builder.hpp.

template<template< typename > typename Role, typename Debug , typename Transport , typename PermessageDeflate = no_compression>
const size_t websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >::max_http_body_size = 32000000
static

Default maximum http body size.

Default value for the http parser's maximum body size. Maximum body size determines the point at which the library will abort reading an HTTP connection with the 413/request entity too large error.

The default is 32MB

Since
0.5.0

Definition at line 230 of file config_builder.hpp.

template<template< typename > typename Role, typename Debug , typename Transport , typename PermessageDeflate = no_compression>
const size_t websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >::max_message_size = 32000000
static

Default maximum message size.

Default value for the processor's maximum message size. Maximum message size determines the point at which the library will fail a connection with the message_too_big protocol error.

The default is 32MB

Since
0.3.0

Definition at line 328 of file config_builder.hpp.

template<template< typename > typename Role, typename Debug , typename Transport , typename PermessageDeflate = no_compression>
const bool websocketpp::config::builder< Role, Debug, Transport, PermessageDeflate >::silent_close = false
static

Suppresses the return of detailed connection close information.

Silence close suppresses the return of detailed connection close information during the closing handshake. This information is useful for debugging and presenting useful errors to end users but may be undesirable for security reasons in some production environments. Close reasons could be used by an attacker to confirm that the endpoint is out of resources or be used to identify the WebSocket implementation in use.

Note: this will suppress all close codes, including those explicitly sent by local applications.

Definition at line 316 of file config_builder.hpp.


The documentation for this struct was generated from the following file: