WebSocket++ 0.8.2
C++ websocket client/server library
sha1.hpp
1/*
2*****
3sha1.hpp is a repackaging of the sha1.cpp and sha1.h files from the smallsha1
4library (http://code.google.com/p/smallsha1/) into a single header suitable for
5use as a header only library. This conversion was done by Peter Thorson
6(webmaster@zaphoyd.com) in 2013. All modifications to the code are redistributed
7under the same license as the original, which is listed below.
8*****
9
10 Copyright (c) 2011, Micael Hildenborg
11 All rights reserved.
12
13 Redistribution and use in source and binary forms, with or without
14 modification, are permitted provided that the following conditions are met:
15 * Redistributions of source code must retain the above copyright
16 notice, this list of conditions and the following disclaimer.
17 * Redistributions in binary form must reproduce the above copyright
18 notice, this list of conditions and the following disclaimer in the
19 documentation and/or other materials provided with the distribution.
20 * Neither the name of Micael Hildenborg nor the
21 names of its contributors may be used to endorse or promote products
22 derived from this software without specific prior written permission.
23
24 THIS SOFTWARE IS PROVIDED BY Micael Hildenborg ''AS IS'' AND ANY
25 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
26 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27 DISCLAIMED. IN NO EVENT SHALL Micael Hildenborg BE LIABLE FOR ANY
28 DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
29 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
30 LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
31 ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
33 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 */
35
36#ifndef SHA1_DEFINED
37#define SHA1_DEFINED
38
39namespace websocketpp {
40namespace sha1 {
41
42namespace { // local
43
44// Rotate an integer value to left.
45inline unsigned int rol(unsigned int value, unsigned int steps) {
46 return ((value << steps) | (value >> (32 - steps)));
47}
48
49// Sets the first 16 integers in the buffert to zero.
50// Used for clearing the W buffert.
51inline void clearWBuffert(unsigned int * buffert)
52{
53 for (int pos = 16; --pos >= 0;)
54 {
55 buffert[pos] = 0;
56 }
57}
58
59inline void innerHash(unsigned int * result, unsigned int * w)
60{
61 unsigned int a = result[0];
62 unsigned int b = result[1];
63 unsigned int c = result[2];
64 unsigned int d = result[3];
65 unsigned int e = result[4];
66
67 int round = 0;
68
69 #define sha1macro(func,val)
70 {
71 const unsigned int t = rol(a, 5) + (func) + e + val + w[round];
72 e = d;
73 d = c;
74 c = rol(b, 30);
75 b = a;
76 a = t;
77 }
78
79 while (round < 16)
80 {
81 sha1macro((b & c) | (~b & d), 0x5a827999)
82 ++round;
83 }
84 while (round < 20)
85 {
86 w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);
87 sha1macro((b & c) | (~b & d), 0x5a827999)
88 ++round;
89 }
90 while (round < 40)
91 {
92 w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);
93 sha1macro(b ^ c ^ d, 0x6ed9eba1)
94 ++round;
95 }
96 while (round < 60)
97 {
98 w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);
99 sha1macro((b & c) | (b & d) | (c & d), 0x8f1bbcdc)
100 ++round;
101 }
102 while (round < 80)
103 {
104 w[round] = rol((w[round - 3] ^ w[round - 8] ^ w[round - 14] ^ w[round - 16]), 1);
105 sha1macro(b ^ c ^ d, 0xca62c1d6)
106 ++round;
107 }
108
109 #undef sha1macro
110
111 result[0] += a;
112 result[1] += b;
113 result[2] += c;
114 result[3] += d;
115 result[4] += e;
116}
117
118} // namespace
119
120/// Calculate a SHA1 hash
121/**
122 * @param src points to any kind of data to be hashed.
123 * @param bytelength the number of bytes to hash from the src pointer.
124 * @param hash should point to a buffer of at least 20 bytes of size for storing
125 * the sha1 result in.
126 */
127inline void calc(void const * src, size_t bytelength, unsigned char * hash) {
128 // Init the result array.
129 unsigned int result[5] = { 0x67452301, 0xefcdab89, 0x98badcfe,
130 0x10325476, 0xc3d2e1f0 };
131
132 // Cast the void src pointer to be the byte array we can work with.
133 unsigned char const * sarray = (unsigned char const *) src;
134
135 // The reusable round buffer
136 unsigned int w[80];
137
138 // Loop through all complete 64byte blocks.
139
140 size_t endCurrentBlock;
141 size_t currentBlock = 0;
142
143 if (bytelength >= 64) {
144 size_t const endOfFullBlocks = bytelength - 64;
145
146 while (currentBlock <= endOfFullBlocks) {
147 endCurrentBlock = currentBlock + 64;
148
149 // Init the round buffer with the 64 byte block data.
150 for (int roundPos = 0; currentBlock < endCurrentBlock; currentBlock += 4)
151 {
152 // This line will swap endian on big endian and keep endian on
153 // little endian.
154 w[roundPos++] = (unsigned int) sarray[currentBlock + 3]
155 | (((unsigned int) sarray[currentBlock + 2]) << 8)
156 | (((unsigned int) sarray[currentBlock + 1]) << 16)
157 | (((unsigned int) sarray[currentBlock]) << 24);
158 }
159 innerHash(result, w);
160 }
161 }
162
163 // Handle the last and not full 64 byte block if existing.
164 endCurrentBlock = bytelength - currentBlock;
165 clearWBuffert(w);
166 size_t lastBlockBytes = 0;
167 for (;lastBlockBytes < endCurrentBlock; ++lastBlockBytes) {
168 w[lastBlockBytes >> 2] |= (unsigned int) sarray[lastBlockBytes + currentBlock] << ((3 - (lastBlockBytes & 3)) << 3);
169 }
170
171 w[lastBlockBytes >> 2] |= 0x80 << ((3 - (lastBlockBytes & 3)) << 3);
172 if (endCurrentBlock >= 56) {
173 innerHash(result, w);
174 clearWBuffert(w);
175 }
176 w[15] = bytelength << 3;
177 innerHash(result, w);
178
179 // Store hash in result pointer, and make sure we get in in the correct
180 // order on both endian models.
181 for (int hashByte = 20; --hashByte >= 0;) {
182 hash[hashByte] = (result[hashByte >> 2] >> (((3 - hashByte) & 0x3) << 3)) & 0xff;
183 }
184}
185
186} // namespace sha1
187} // namespace websocketpp
188
189#endif // SHA1_DEFINED
#define _WEBSOCKETPP_CPP11_FUNCTIONAL_
#define _WEBSOCKETPP_CPP11_THREAD_
#define _WEBSOCKETPP_CPP11_MEMORY_
#define _WEBSOCKETPP_CPP11_SYSTEM_ERROR_
#define _WEBSOCKETPP_INITIALIZER_LISTS_
Concurrency policy that uses std::mutex / boost::mutex.
Definition: basic.hpp:37
Stub for user supplied base class.
Represents an individual WebSocket connection.
Definition: connection.hpp:238
ptr get_shared()
Get a shared pointer to this component.
Definition: connection.hpp:336
void handle_interrupt()
Transport inturrupt callback.
void set_message_handler(message_handler h)
Set message handler.
Definition: connection.hpp:473
lib::error_code interrupt()
Asyncronously invoke handler::on_inturrupt.
void start()
Start the connection state machine.
std::string const & get_request_body() const
Retrieve a request body.
config::transport_type::transport_con_type transport_con_type
Type of the transport component of this connection.
Definition: connection.hpp:256
void ping(std::string const &payload)
Send a ping.
void set_close_handler(close_handler h)
Set close handler.
Definition: connection.hpp:361
void set_pong_handler(pong_handler h)
Set pong handler.
Definition: connection.hpp:398
lib::error_code send(message_ptr msg)
Add a message to the outgoing send queue.
config::alog_type alog_type
Type of the access logging policy.
Definition: connection.hpp:250
http::status_code::value get_response_code() const
Get response HTTP status code.
Definition: connection.hpp:983
lib::error_code defer_http_response()
Defer HTTP Response until later (Exception free)
lib::error_code resume_reading()
Resume reading of new data.
void add_subprotocol(std::string const &request, lib::error_code &ec)
Adds the given subprotocol string to the request list (exception free)
void add_subprotocol(std::string const &request)
Adds the given subprotocol string to the request list.
bool get_secure() const
Returns the secure flag from the connection URI.
void set_close_handshake_timeout(long dur)
Set close handshake timeout.
Definition: connection.hpp:525
void set_body(std::string const &value)
Set response body content.
size_t get_buffered_amount() const
Get the size of the outgoing write buffer (in payload bytes)
std::string const & get_origin() const
Return the same origin policy origin value from the opening request.
void close(close::status::value const code, std::string const &reason, lib::error_code &ec)
exception free variant of close
std::string const & get_host() const
Returns the host component of the connection URI.
response_type const & get_response() const
Get response object.
void set_max_message_size(size_t new_value)
Set maximum message size.
Definition: connection.hpp:575
std::string const & get_resource() const
Returns the resource component of the connection URI.
void select_subprotocol(std::string const &value, lib::error_code &ec)
Select a subprotocol to use (exception free)
std::string const & get_request_header(std::string const &key) const
Retrieve a request header.
lib::error_code process_handshake_request()
void handle_pause_reading()
Pause reading callback.
std::vector< int > const & get_supported_versions() const
Get array of WebSocket protocol versions that this connection supports.
lib::error_code send(void const *payload, size_t len, frame::opcode::value op=frame::opcode::binary)
Send a message (raw array overload)
void remove_header(std::string const &key)
Remove a header.
uri_ptr get_uri() const
Gets the connection URI.
void ping(std::string const &payload, lib::error_code &ec)
exception free variant of ping
connection_hdl get_handle() const
Get Connection Handle.
void set_pong_timeout_handler(pong_timeout_handler h)
Set pong timeout handler.
Definition: connection.hpp:421
void send_http_response(lib::error_code &ec)
Send deferred HTTP Response (exception free)
connection< config > type
Type of this connection.
Definition: connection.hpp:241
void set_ping_handler(ping_handler h)
Set ping handler.
Definition: connection.hpp:387
std::string const & get_response_header(std::string const &key) const
Retrieve a response header.
void set_http_handler(http_handler h)
Set http handler.
Definition: connection.hpp:447
std::string const & get_response_msg() const
Get response HTTP status message.
Definition: connection.hpp:995
config::elog_type elog_type
Type of the error logging policy.
Definition: connection.hpp:252
void pong(std::string const &payload, lib::error_code &ec)
exception free variant of pong
message_ptr get_message(websocketpp::frame::opcode::value op, size_t size) const
Get a message buffer.
void handle_write_frame(lib::error_code const &ec)
Process the results of a frame write operation and start the next write.
close::status::value get_local_close_code() const
Get the WebSocket close code sent by this endpoint.
lib::error_code get_ec() const
Get the internal error code for a closed/failed connection.
void set_fail_handler(fail_handler h)
Set fail handler.
Definition: connection.hpp:372
void write_frame()
Checks if there are frames in the send queue and if there are sends one.
session::state::value get_state() const
Return the connection state.
void select_subprotocol(std::string const &value)
Select a subprotocol to use.
void set_status(http::status_code::value code)
Set response status code and message.
void replace_header(std::string const &key, std::string const &val)
Replace a header.
void set_status(http::status_code::value code, std::string const &msg)
Set response status code and message.
size_t get_max_http_body_size() const
Get maximum HTTP message body size.
Definition: connection.hpp:594
config::concurrency_type concurrency_type
Type of the concurrency component of this connection.
Definition: connection.hpp:248
transport_con_type::timer_ptr timer_ptr
Type of a pointer to a transport timer handle.
Definition: connection.hpp:284
void set_validate_handler(validate_handler h)
Set validate handler.
Definition: connection.hpp:463
void pong(std::string const &payload)
Send a pong.
void set_interrupt_handler(interrupt_handler h)
Set interrupt handler.
Definition: connection.hpp:432
size_t buffered_amount() const
Get the size of the outgoing write buffer (in payload bytes)
Definition: connection.hpp:635
void send_http_response()
Send deferred HTTP Response.
close::status::value get_remote_close_code() const
Get the WebSocket close code sent by the remote endpoint.
void set_open_handler(open_handler h)
Set open handler.
Definition: connection.hpp:351
bool is_server() const
Get whether or not this connection is part of a server or client.
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection.
Definition: connection.hpp:243
std::string const & get_remote_close_reason() const
Get the WebSocket close reason sent by the remote endpoint.
void set_pong_timeout(long dur)
Set pong timeout.
Definition: connection.hpp:546
lib::error_code initialize_processor()
void set_uri(uri_ptr uri)
Sets the connection URI.
void set_termination_handler(termination_handler new_handler)
request_type const & get_request() const
Get request object.
void set_max_http_body_size(size_t new_value)
Set maximum HTTP message body size.
Definition: connection.hpp:610
transport_con_type::ptr transport_con_ptr
Type of a shared pointer to the transport component of this connection.
Definition: connection.hpp:258
void set_open_handshake_timeout(long dur)
Set open handshake timeout.
Definition: connection.hpp:501
lib::error_code pause_reading()
Pause reading of new data.
void handle_resume_reading()
Resume reading callback.
std::vector< std::string > const & get_requested_subprotocols() const
Gets all of the subprotocols requested by the client.
void close(close::status::value const code, std::string const &reason)
Close the connection.
std::string const & get_subprotocol() const
Gets the negotated subprotocol.
void set_handle(connection_hdl hdl)
Set Connection Handle.
void handle_pong_timeout(std::string payload, lib::error_code const &ec)
Utility method that gets called back when the ping timer expires.
lib::error_code send(std::string const &payload, frame::opcode::value op=frame::opcode::text)
Create a message and then add it to the outgoing send queue.
void read_frame()
Issue a new transport read unless reading is paused.
uint16_t get_port() const
Returns the port component of the connection URI.
std::string const & get_local_close_reason() const
Get the WebSocket close reason sent by this endpoint.
size_t get_max_message_size() const
Get maximum message size.
Definition: connection.hpp:559
void append_header(std::string const &key, std::string const &val)
Append a header.
config::rng_type rng_type
Type of RNG.
Definition: connection.hpp:275
Stub for user supplied base class.
Creates and manages connections associated with a WebSocket endpoint.
Definition: endpoint.hpp:42
void set_max_http_body_size(size_t new_value)
Set maximum HTTP message body size.
Definition: endpoint.hpp:466
void set_user_agent(std::string const &ua)
Sets the user agent string that this endpoint will use.
Definition: endpoint.hpp:196
connection_ptr get_con_from_hdl(connection_hdl hdl, lib::error_code &ec)
Retrieves a connection_ptr from a connection_hdl (exception free)
Definition: endpoint.hpp:643
config::concurrency_type concurrency_type
Type of the concurrency component of this endpoint.
Definition: endpoint.hpp:51
config::alog_type alog_type
Type of access logger.
Definition: endpoint.hpp:75
void ping(connection_hdl hdl, std::string const &payload, lib::error_code &ec)
Send a ping to a specific connection.
alog_type & get_alog()
Get reference to access logger.
Definition: endpoint.hpp:261
transport_con_type::ptr transport_con_ptr
Definition: endpoint.hpp:65
std::string get_user_agent() const
Returns the user agent string that this endpoint will use.
Definition: endpoint.hpp:169
void ping(connection_hdl hdl, std::string const &payload)
Send a ping to a specific connection.
void clear_access_channels(log::level channels)
Clear Access logging channels.
Definition: endpoint.hpp:231
void resume_reading(connection_hdl hdl)
Resume reading of new data.
config::elog_type elog_type
Type of error logger.
Definition: endpoint.hpp:73
elog_type & get_elog()
Get reference to error logger.
Definition: endpoint.hpp:269
bool is_server() const
Returns whether or not this endpoint is a server.
Definition: endpoint.hpp:205
void send(connection_hdl hdl, std::string const &payload, frame::opcode::value op, lib::error_code &ec)
Create a message and add it to the outgoing send queue (exception free)
void set_close_handshake_timeout(long dur)
Set close handshake timeout.
Definition: endpoint.hpp:377
connection_type::message_ptr message_ptr
Type of message pointers that this endpoint uses.
Definition: endpoint.hpp:70
void pong(connection_hdl hdl, std::string const &payload, lib::error_code &ec)
Send a pong to a specific connection.
void set_access_channels(log::level channels)
Set Access logging channel.
Definition: endpoint.hpp:220
void set_max_message_size(size_t new_value)
Set default maximum message size.
Definition: endpoint.hpp:432
size_t get_max_message_size() const
Get default maximum message size.
Definition: endpoint.hpp:415
connection_ptr get_con_from_hdl(connection_hdl hdl)
Retrieves a connection_ptr from a connection_hdl (exception version)
Definition: endpoint.hpp:653
connection connection_type
Type of the connections that this endpoint creates.
Definition: endpoint.hpp:54
void set_error_channels(log::level channels)
Set Error logging channel.
Definition: endpoint.hpp:242
config::transport_type transport_type
Type of the transport component of this endpoint.
Definition: endpoint.hpp:49
void clear_error_channels(log::level channels)
Clear Error logging channels.
Definition: endpoint.hpp:253
void resume_reading(connection_hdl hdl, lib::error_code &ec)
Resume reading of new data (exception free)
void send(connection_hdl hdl, std::string const &payload, frame::opcode::value op)
Create a message and add it to the outgoing send queue.
connection_type::ptr connection_ptr
Shared pointer to connection_type.
Definition: endpoint.hpp:56
transport_type::transport_con_type transport_con_type
Definition: endpoint.hpp:62
concurrency_type::mutex_type mutex_type
Type of our concurrency policy's mutex object.
Definition: endpoint.hpp:80
void pong(connection_hdl hdl, std::string const &payload)
Send a pong to a specific connection.
void interrupt(connection_hdl hdl, lib::error_code &ec)
void set_pong_timeout(long dur)
Set pong timeout.
Definition: endpoint.hpp:399
size_t get_max_http_body_size() const
Get maximum HTTP message body size.
Definition: endpoint.hpp:449
void set_open_handshake_timeout(long dur)
Set open handshake timeout.
Definition: endpoint.hpp:352
config::rng_type rng_type
Type of RNG.
Definition: endpoint.hpp:83
concurrency_type::scoped_lock_type scoped_lock_type
Type of our concurrency policy's scoped lock object.
Definition: endpoint.hpp:78
void send_http_response(connection_hdl hdl, lib::error_code &ec)
Send deferred HTTP Response.
void pause_reading(connection_hdl hdl, lib::error_code &ec)
Pause reading of new data (exception free)
void send_http_response(connection_hdl hdl)
Send deferred HTTP Response (exception free)
void pause_reading(connection_hdl hdl)
Pause reading of new data.
connection_type::message_handler message_handler
Type of message_handler.
Definition: endpoint.hpp:68
connection_type::weak_ptr connection_weak_ptr
Weak pointer to connection type.
Definition: endpoint.hpp:58
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
lib::error_code compress(std::string const &, std::string &)
Compress bytes.
Definition: disabled.hpp:109
std::string generate_offer() const
Generate extension offer.
Definition: disabled.hpp:99
lib::error_code decompress(uint8_t const *, size_t, std::string &)
Decompress bytes.
Definition: disabled.hpp:120
lib::error_code init(bool)
Initialize state.
Definition: disabled.hpp:76
header_list const & get_headers() const
Return a list of all HTTP headers.
Definition: parser.hpp:179
size_t process_body(char const *buf, size_t len)
Process body data.
Definition: parser.hpp:145
std::string const & get_body() const
Get HTTP body.
Definition: parser.hpp:505
bool get_header_as_plist(std::string const &key, parameter_list &out) const
Extract an HTTP parameter list from a parser header.
Definition: parser.hpp:55
void process_header(std::string::iterator begin, std::string::iterator end)
Process a header line.
Definition: parser.hpp:161
void set_version(std::string const &version)
Set HTTP parser Version.
Definition: parser.hpp:41
void remove_header(std::string const &key)
Remove a header from the parser.
Definition: parser.hpp:87
void set_body(std::string const &value)
Set body content.
Definition: parser.hpp:91
bool body_ready() const
Check if the parser is done parsing the body.
Definition: parser.hpp:599
bool prepare_body()
Prepare the parser to begin parsing body data.
Definition: parser.hpp:119
void set_max_body_size(size_t value)
Set body size limit.
Definition: parser.hpp:542
void replace_header(std::string const &key, std::string const &val)
Set a value for an HTTP header, replacing an existing value.
Definition: parser.hpp:81
void append_header(std::string const &key, std::string const &val)
Append a value to an existing HTTP header.
Definition: parser.hpp:67
std::string raw_headers() const
Generate and return the HTTP headers as a string.
Definition: parser.hpp:183
std::string const & get_header(std::string const &key) const
Get the value of an HTTP header.
Definition: parser.hpp:45
std::string const & get_version() const
Get the HTTP version string.
Definition: parser.hpp:410
bool parse_parameter_list(std::string const &in, parameter_list &out) const
Extract an HTTP parameter list from a string.
Definition: parser.hpp:107
size_t get_max_body_size() const
Get body size limit.
Definition: parser.hpp:529
Stores, parses, and manipulates HTTP requests.
Definition: request.hpp:50
std::string raw() const
Returns the full raw request (including the body)
Definition: request.hpp:131
std::string const & get_uri() const
Return the requested URI.
Definition: request.hpp:104
std::string const & get_method() const
Return the request method.
Definition: request.hpp:96
size_t consume(char const *buf, size_t len)
Process bytes in the input buffer.
Definition: request.hpp:41
void set_uri(std::string const &uri)
Set the HTTP uri. Must be a valid HTTP uri.
Definition: request.hpp:159
bool ready() const
Returns whether or not the request is ready for reading.
Definition: request.hpp:82
void set_method(std::string const &method)
Set the HTTP method. Must be a valid HTTP token.
Definition: request.hpp:151
std::string raw_head() const
Returns the raw request headers only (similar to an HTTP HEAD request)
Definition: request.hpp:141
Stores, parses, and manipulates HTTP responses.
Definition: response.hpp:57
void set_status(status_code::value code)
Set response status code and message.
Definition: response.hpp:191
std::string raw() const
Returns the full raw response.
Definition: response.hpp:178
size_t consume(std::istream &s)
Process bytes in the input buffer (istream version)
Definition: response.hpp:139
bool headers_ready() const
Returns true if the response headers are fully parsed.
Definition: response.hpp:121
bool ready() const
Returns true if the response is ready.
Definition: response.hpp:116
void set_status(status_code::value code, std::string const &msg)
Set response status code and message.
Definition: response.hpp:197
const std::string & get_status_msg() const
Return the response status message.
Definition: response.hpp:157
status_code::value get_status_code() const
Return the response status code.
Definition: response.hpp:152
size_t consume(char const *buf, size_t len)
Process bytes in the input buffer.
Definition: response.hpp:42
Basic logger that outputs to an ostream.
Definition: basic.hpp:59
void write(level channel, char const *msg)
Write a cstring message to the given channel.
Definition: basic.hpp:151
void write(level channel, std::string const &msg)
Write a string message to the given channel.
Definition: basic.hpp:137
bool recycle(message *)
Recycle a message.
Definition: alloc.hpp:80
message_ptr get_message(frame::opcode::value op, size_t size)
Get a message buffer with specified size and opcode.
Definition: alloc.hpp:66
message_ptr get_message()
Get an empty message buffer.
Definition: alloc.hpp:55
con_msg_man_ptr get_manager() const
Get a pointer to a connection message manager.
Definition: alloc.hpp:96
Represents a buffer for a single WebSocket message.
Definition: message.hpp:84
message(const con_msg_man_ptr manager, frame::opcode::value op, size_t size=128)
Construct a message and fill in some values.
Definition: message.hpp:107
std::string & get_raw_payload()
Get a non-const reference to the payload string.
Definition: message.hpp:254
void set_header(std::string const &header)
Set prepared frame header.
Definition: message.hpp:234
bool recycle()
Recycle the message.
Definition: message.hpp:316
bool get_compressed() const
Return whether or not the message is flagged as compressed.
Definition: message.hpp:143
void set_payload(std::string const &payload)
Set payload data.
Definition: message.hpp:264
bool get_terminal() const
Get whether or not the message is terminal.
Definition: message.hpp:169
std::string const & get_header() const
Return the prepared frame header.
Definition: message.hpp:224
void set_payload(void const *payload, size_t len)
Set payload data.
Definition: message.hpp:275
bool get_fin() const
Read the fin bit.
Definition: message.hpp:195
void append_payload(void const *payload, size_t len)
Append payload data.
Definition: message.hpp:298
void set_opcode(frame::opcode::value op)
Set the opcode.
Definition: message.hpp:215
void set_prepared(bool value)
Set or clear the flag that indicates that the message has been prepared.
Definition: message.hpp:135
frame::opcode::value get_opcode() const
Return the message opcode.
Definition: message.hpp:210
void set_terminal(bool value)
Set the terminal flag.
Definition: message.hpp:181
bool get_prepared() const
Return whether or not the message has been prepared for sending.
Definition: message.hpp:125
void append_payload(std::string const &payload)
Append payload data.
Definition: message.hpp:287
void set_compressed(bool value)
Set or clear the compression flag.
Definition: message.hpp:156
message(const con_msg_man_ptr manager)
Construct an empty message.
Definition: message.hpp:96
void set_fin(bool value)
Set the fin bit.
Definition: message.hpp:205
std::string const & get_payload() const
Get a reference to the payload string.
Definition: message.hpp:246
Category for processor errors.
Definition: base.hpp:161
Processor for Hybi Draft version 00.
Definition: hybi00.hpp:54
std::string get_raw(response_type const &res) const
Given a completed response, get the raw bytes to put on the wire.
Definition: hybi00.hpp:179
lib::error_code prepare_ping(std::string const &, message_ptr) const
Prepare a ping frame.
Definition: hybi00.hpp:373
lib::error_code prepare_pong(std::string const &, message_ptr) const
Prepare a pong frame.
Definition: hybi00.hpp:386
lib::error_code process_handshake(request_type const &req, std::string const &subprotocol, response_type &res) const
Calculate the appropriate response for this websocket request.
Definition: hybi00.hpp:100
lib::error_code client_handshake_request(request_type &, uri_ptr, std::vector< std::string > const &) const
Fill in a set of request headers for a client connection request.
Definition: hybi00.hpp:158
std::string get_key3() const
Get hybi00 handshake key3.
Definition: hybi00.hpp:247
size_t consume(uint8_t *buf, size_t len, lib::error_code &ec)
Process new websocket connection bytes.
Definition: hybi00.hpp:252
bool get_error() const
Tests whether the processor is in a fatal error state.
Definition: hybi00.hpp:313
bool ready() const
Checks if there is a message ready.
Definition: hybi00.hpp:309
lib::error_code validate_server_handshake_response(request_type const &, response_type &) const
Validate the server's response to an outgoing handshake request.
Definition: hybi00.hpp:173
lib::error_code prepare_close(close::status::value, std::string const &, message_ptr out) const
Prepare a close frame.
Definition: hybi00.hpp:401
virtual lib::error_code prepare_data_frame(message_ptr in, message_ptr out)
Prepare a message for writing.
Definition: hybi00.hpp:329
lib::error_code validate_handshake(request_type const &r) const
validate a WebSocket handshake request for this version
Definition: hybi00.hpp:77
int get_version() const
Get the protocol version of this processor.
Definition: hybi00.hpp:73
uri_ptr get_uri(request_type const &request) const
Extracts client uri from a handshake request.
Definition: hybi00.hpp:217
lib::error_code extract_subprotocols(request_type const &req, std::vector< std::string > &subprotocol_list)
Extracts requested subprotocols from a handshake request.
Definition: hybi00.hpp:198
std::string const & get_origin(request_type const &r) const
Return the value of the header containing the CORS origin.
Definition: hybi00.hpp:185
message_ptr get_message()
Retrieves the most recently processed message.
Definition: hybi00.hpp:317
Processor for Hybi Draft version 07.
Definition: hybi07.hpp:44
int get_version() const
Get the protocol version of this processor.
Definition: hybi07.hpp:69
lib::error_code client_handshake_request(request_type &, uri_ptr, std::vector< std::string > const &) const
Fill in a set of request headers for a client connection request.
Definition: hybi07.hpp:63
Processor for Hybi Draft version 08.
Definition: hybi08.hpp:44
lib::error_code client_handshake_request(request_type &, uri_ptr, std::vector< std::string > const &) const
Fill in a set of request headers for a client connection request.
Definition: hybi08.hpp:64
std::string const & get_origin(request_type const &r) const
Return the value of the header containing the CORS origin.
Definition: hybi08.hpp:74
int get_version() const
Get the protocol version of this processor.
Definition: hybi08.hpp:70
Processor for Hybi version 13 (RFC6455)
Definition: hybi13.hpp:54
lib::error_code validate_incoming_basic_header(frame::basic_header const &h, bool is_server, bool new_msg) const
Validate an incoming basic header.
Definition: hybi13.hpp:848
size_t get_bytes_needed() const
Definition: hybi13.hpp:590
err_str_pair negotiate_extensions_helper(header_type const &header)
Extension negotiation helper function.
Definition: hybi13.hpp:102
lib::error_code prepare_ping(std::string const &in, message_ptr out) const
Get URI.
Definition: hybi13.hpp:688
lib::error_code extract_subprotocols(request_type const &req, std::vector< std::string > &subprotocol_list)
Extracts requested subprotocols from a handshake request.
Definition: hybi13.hpp:332
uri_ptr get_uri(request_type const &request) const
Extracts client uri from a handshake request.
Definition: hybi13.hpp:351
lib::error_code client_handshake_request(request_type &req, uri_ptr uri, std::vector< std::string > const &subprotocols) const
Fill in a set of request headers for a client connection request.
Definition: hybi13.hpp:237
lib::error_code prepare_control(frame::opcode::value op, std::string const &payload, message_ptr out) const
Generic prepare control frame with opcode and payload.
Definition: hybi13.hpp:977
err_str_pair negotiate_extensions(response_type const &response)
Initializes extensions based on the Sec-WebSocket-Extensions header.
Definition: hybi13.hpp:92
size_t consume(uint8_t *buf, size_t len, lib::error_code &ec)
Process new websocket connection bytes.
Definition: hybi13.hpp:382
bool get_error() const
Test whether or not the processor is in a fatal error state.
Definition: hybi13.hpp:586
virtual lib::error_code prepare_data_frame(message_ptr in, message_ptr out)
Prepare a user data message for writing.
Definition: hybi13.hpp:605
size_t copy_basic_header_bytes(uint8_t const *buf, size_t len)
Reads bytes from buf into m_basic_header.
Definition: hybi13.hpp:744
size_t copy_extended_header_bytes(uint8_t const *buf, size_t len)
Reads bytes from buf into m_extended_header.
Definition: hybi13.hpp:776
void masked_copy(std::string const &i, std::string &o, frame::masking_key_type key) const
Copy and mask/unmask in one operation.
Definition: hybi13.hpp:961
lib::error_code validate_server_handshake_response(request_type const &req, response_type &res) const
Validate the server's response to an outgoing handshake request.
Definition: hybi13.hpp:287
virtual lib::error_code prepare_close(close::status::value code, std::string const &reason, message_ptr out) const
Prepare a close frame.
Definition: hybi13.hpp:696
message_ptr get_message()
Retrieves the most recently processed message.
Definition: hybi13.hpp:567
lib::error_code finalize_message()
Perform any finalization actions on an incoming message.
Definition: hybi13.hpp:518
std::string const & get_origin(request_type const &r) const
Return the value of the header containing the CORS origin.
Definition: hybi13.hpp:328
lib::error_code process_handshake(request_type const &request, std::string const &subprotocol, response_type &response) const
Calculate the appropriate response for this websocket request.
Definition: hybi13.hpp:209
size_t process_payload_bytes(uint8_t *buf, size_t len, lib::error_code &ec)
Reads bytes from buf into message payload.
Definition: hybi13.hpp:799
std::string get_raw(response_type const &res) const
Given a completed response, get the raw bytes to put on the wire.
Definition: hybi13.hpp:324
lib::error_code prepare_pong(std::string const &in, message_ptr out) const
Prepare a pong frame.
Definition: hybi13.hpp:692
lib::error_code validate_incoming_extended_header(frame::basic_header h, frame::extended_header e) const
Validate an incoming extended header.
Definition: hybi13.hpp:926
err_str_pair negotiate_extensions(request_type const &request)
Initializes extensions based on the Sec-WebSocket-Extensions header.
Definition: hybi13.hpp:88
bool ready() const
Test whether or not the processor has a message ready.
Definition: hybi13.hpp:563
lib::error_code validate_handshake(request_type const &r) const
validate a WebSocket handshake request for this version
Definition: hybi13.hpp:185
lib::error_code process_handshake_key(std::string &key) const
Convert a client handshake key into a server response key in place.
Definition: hybi13.hpp:733
int get_version() const
Get the protocol version of this processor.
Definition: hybi13.hpp:80
WebSocket protocol processor abstract base class.
Definition: processor.hpp:160
virtual lib::error_code prepare_data_frame(message_ptr in, message_ptr out)=0
Prepare a data message for writing.
virtual size_t get_bytes_needed() const
Definition: processor.hpp:349
virtual size_t consume(uint8_t *buf, size_t len, lib::error_code &ec)=0
process new websocket connection bytes
virtual lib::error_code prepare_close(close::status::value code, std::string const &reason, message_ptr out) const =0
Prepare a close frame.
virtual err_str_pair negotiate_extensions(response_type const &)
Initializes extensions based on the Sec-WebSocket-Extensions header.
Definition: processor.hpp:239
virtual int get_version() const =0
Get the protocol version of this processor.
virtual std::string get_raw(response_type const &request) const =0
Given a completed response, get the raw bytes to put on the wire.
virtual bool ready() const =0
Checks if there is a message ready.
virtual lib::error_code process_handshake(request_type const &req, std::string const &subprotocol, response_type &res) const =0
Calculate the appropriate response for this websocket request.
virtual lib::error_code validate_handshake(request_type const &request) const =0
validate a WebSocket handshake request for this version
virtual uri_ptr get_uri(request_type const &request) const =0
Extracts client uri from a handshake request.
virtual err_str_pair negotiate_extensions(request_type const &)
Initializes extensions based on the Sec-WebSocket-Extensions header.
Definition: processor.hpp:225
virtual bool has_permessage_compress() const
Returns whether or not the permessage_compress extension is implemented.
Definition: processor.hpp:212
virtual lib::error_code prepare_ping(std::string const &in, message_ptr out) const =0
Prepare a ping frame.
virtual lib::error_code validate_server_handshake_response(request_type const &req, response_type &res) const =0
Validate the server's response to an outgoing handshake request.
virtual lib::error_code client_handshake_request(request_type &req, uri_ptr uri, std::vector< std::string > const &subprotocols) const =0
Fill in an HTTP request for an outgoing connection handshake.
virtual lib::error_code extract_subprotocols(const request_type &req, std::vector< std::string > &subprotocol_list)=0
Extracts requested subprotocols from a handshake request.
virtual bool get_error() const =0
Tests whether the processor is in a fatal error state.
void set_max_message_size(size_t new_value)
Set maximum message size.
Definition: processor.hpp:203
virtual std::string const & get_origin(request_type const &request) const =0
Return the value of the header containing the CORS origin.
size_t get_max_message_size() const
Get maximum message size.
Definition: processor.hpp:188
virtual message_ptr get_message()=0
Retrieves the most recently processed message.
virtual lib::error_code prepare_pong(std::string const &in, message_ptr out) const =0
Prepare a pong frame.
Thread safe stub "random" integer generator.
Definition: none.hpp:46
int_type operator()()
advances the engine's state and returns the generated value
Definition: none.hpp:51
Server endpoint role based on the given config.
void start_accept(lib::error_code &ec)
Starts the server's async connection acceptance loop (exception free)
transport_type::transport_con_type transport_con_type
Type of the connection transport component.
connection_type::ptr connection_ptr
Type of a shared pointer to the connections this server will create.
server< config > type
Type of this endpoint.
endpoint< connection_type, config > endpoint_type
Type of the endpoint component of this server.
config::transport_type transport_type
Type of the endpoint transport component.
connection< config > connection_type
Type of the connections this server will create.
connection_ptr get_connection()
Create and initialize a new connection.
void handle_accept(connection_ptr con, lib::error_code const &ec)
Handler callback for start_accept.
void start_accept()
Starts the server's async connection acceptance loop.
config::concurrency_type concurrency_type
Type of the endpoint concurrency component.
transport_con_type::ptr transport_con_ptr
Type of a shared pointer to the connection transport component.
Basic Asio connection socket component.
Definition: none.hpp:58
lib::asio::ip::tcp::socket & get_raw_socket()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:124
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection socket component.
Definition: none.hpp:63
void set_socket_init_handler(socket_init_handler h)
Set the socket initialization handler.
Definition: none.hpp:100
connection type
Type of this connection socket component.
Definition: none.hpp:61
lib::asio::ip::tcp::socket & get_socket()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:108
bool is_secure() const
Check whether or not this connection is secure.
Definition: none.hpp:88
lib::shared_ptr< socket_type > socket_ptr
Type of a shared pointer to the socket being used.
Definition: none.hpp:72
static lib::error_code translate_ec(lib::error_code ec)
Definition: none.hpp:292
static lib::error_code translate_ec(ErrorCodeType)
Translate any security policy specific information about an error code.
Definition: none.hpp:284
void set_handle(connection_hdl hdl)
Sets the connection handle.
Definition: none.hpp:234
lib::asio::error_code cancel_socket()
Cancel all async operations on this socket.
Definition: none.hpp:247
void pre_init(init_handler callback)
Pre-initialize security policy.
Definition: none.hpp:204
std::string get_remote_endpoint(lib::error_code &ec) const
Get the remote endpoint address.
Definition: none.hpp:138
void post_init(init_handler callback)
Post-initialize security policy.
Definition: none.hpp:223
lib::error_code init_asio(io_service_ptr service, strand_ptr, bool)
Perform one time initializations.
Definition: none.hpp:165
lib::asio::ip::tcp::socket socket_type
Type of the ASIO socket being used.
Definition: none.hpp:70
ptr get_shared()
Get a shared pointer to this component.
Definition: none.hpp:80
lib::shared_ptr< lib::asio::io_service::strand > strand_ptr
Type of a pointer to the Asio io_service strand being used.
Definition: none.hpp:68
lib::asio::ip::tcp::socket & get_next_layer()
Retrieve a pointer to the underlying socket.
Definition: none.hpp:116
lib::asio::io_service * io_service_ptr
Type of a pointer to the Asio io_service being used.
Definition: none.hpp:66
Basic ASIO endpoint socket component.
Definition: none.hpp:317
void set_socket_init_handler(socket_init_handler h)
Set socket init handler.
Definition: none.hpp:346
lib::error_code init(socket_con_ptr scon)
Initialize a connection.
Definition: none.hpp:359
endpoint type
The type of this endpoint socket component.
Definition: none.hpp:320
bool is_secure() const
Checks whether the endpoint creates secure connections.
Definition: none.hpp:334
connection socket_con_type
The type of the corresponding connection socket component.
Definition: none.hpp:323
Asio based connection transport component.
Definition: connection.hpp:67
void set_proxy_timeout(long duration)
Set the proxy timeout duration (exception)
Definition: connection.hpp:261
void set_tcp_post_init_handler(tcp_init_handler h)
Sets the tcp post init handler.
Definition: connection.hpp:173
void set_proxy_basic_auth(std::string const &username, std::string const &password)
Set the basic auth credentials to use (exception)
Definition: connection.hpp:232
void set_proxy_timeout(long duration, lib::error_code &ec)
Set the proxy timeout duration (exception free)
Definition: connection.hpp:250
config::elog_type elog_type
Type of this transport's error logging policy.
Definition: connection.hpp:81
strand_ptr get_strand()
Get a pointer to this connection's strand.
Definition: connection.hpp:366
void async_read_at_least(size_t num_bytes, char *buf, size_t len, read_handler handler)
read at least num_bytes bytes into buf and then call handler.
Definition: connection.hpp:820
lib::error_code proxy_init(std::string const &authority)
initialize the proxy buffers and http parsers
Definition: connection.hpp:437
socket_con_type::ptr socket_con_ptr
Type of a shared pointer to the socket connection component.
Definition: connection.hpp:77
lib::error_code interrupt(interrupt_handler handler)
Trigger the on_interrupt handler.
config::alog_type alog_type
Type of this transport's access logging policy.
Definition: connection.hpp:79
void handle_async_write(write_handler handler, lib::asio::error_code const &ec, size_t)
Async write callback.
Definition: connection.hpp:980
void handle_timer(timer_ptr, timer_handler callback, lib::asio::error_code const &ec)
Timer callback.
Definition: connection.hpp:350
lib::error_code init_asio(io_service_ptr io_service)
Finish constructing the transport.
Definition: connection.hpp:461
void handle_post_init(timer_ptr post_timer, init_handler callback, lib::error_code const &ec)
Post init timeout callback.
Definition: connection.hpp:572
void async_shutdown(shutdown_handler callback)
close and clean up the underlying socket
lib::asio::error_code get_transport_ec() const
Get the internal transport error code for a closed/failed connection.
Definition: connection.hpp:389
config::socket_type::socket_con_type socket_con_type
Type of the socket connection component.
Definition: connection.hpp:75
lib::asio::io_service * io_service_ptr
Type of a pointer to the Asio io_service being used.
Definition: connection.hpp:89
void set_proxy(std::string const &uri)
Set the proxy to connect through (exception)
Definition: connection.hpp:198
void handle_post_init_timeout(timer_ptr, init_handler callback, lib::error_code const &ec)
Post init timeout callback.
Definition: connection.hpp:536
connection< config > type
Type of this connection transport component.
Definition: connection.hpp:70
void handle_async_shutdown_timeout(timer_ptr, init_handler callback, lib::error_code const &ec)
Async shutdown timeout handler.
void set_proxy(std::string const &uri, lib::error_code &ec)
Set the proxy to connect through (exception free)
Definition: connection.hpp:189
lib::shared_ptr< lib::asio::steady_timer > timer_ptr
Type of a pointer to the Asio timer class.
Definition: connection.hpp:93
void set_proxy_basic_auth(std::string const &username, std::string const &password, lib::error_code &ec)
Set the basic auth credentials to use (exception free)
Definition: connection.hpp:217
void async_write(const char *buf, size_t len, write_handler handler)
Initiate a potentially asyncronous write of the given buffer.
Definition: connection.hpp:906
void async_write(std::vector< buffer > const &bufs, write_handler handler)
Initiate a potentially asyncronous write of the given buffers.
Definition: connection.hpp:939
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
Definition: connection.hpp:72
timer_ptr set_timer(long duration, timer_handler callback)
Call back a function after a period of time.
Definition: connection.hpp:313
void set_tcp_init_handler(tcp_init_handler h)
Sets the tcp pre init handler (deprecated)
Definition: connection.hpp:158
void handle_proxy_read(init_handler callback, lib::asio::error_code const &ec, size_t)
Proxy read callback.
Definition: connection.hpp:742
void set_uri(uri_ptr u)
Set uri hook.
Definition: connection.hpp:130
std::string get_remote_endpoint() const
Get the remote endpoint address.
Definition: connection.hpp:281
ptr get_shared()
Get a shared pointer to this component.
Definition: connection.hpp:110
void cancel_socket_checked()
Cancel the underlying socket and log any errors.
void set_handle(connection_hdl hdl)
Set Connection Handle.
void set_tcp_pre_init_handler(tcp_init_handler h)
Sets the tcp pre init handler.
Definition: connection.hpp:144
lib::shared_ptr< lib::asio::io_service::strand > strand_ptr
Type of a pointer to the Asio io_service::strand being used.
Definition: connection.hpp:91
void init(init_handler callback)
Initialize transport for reading.
Definition: connection.hpp:411
connection_hdl get_handle() const
Get the connection handle.
Definition: connection.hpp:295
Asio based endpoint transport component.
Definition: endpoint.hpp:54
std::size_t run_one()
wraps the run_one method of the internal io_service object
Definition: endpoint.hpp:648
socket_type::socket_con_type socket_con_type
Type of the socket connection component.
Definition: endpoint.hpp:69
void stop_listening(lib::error_code &ec)
Stop listening (exception free)
Definition: endpoint.hpp:604
config::socket_type socket_type
Type of the socket policy.
Definition: endpoint.hpp:62
lib::shared_ptr< lib::asio::steady_timer > timer_ptr
Type of timer handle.
Definition: endpoint.hpp:87
void async_connect(transport_con_ptr tcon, uri_ptr u, connect_handler cb)
Initiate a new connection.
Definition: endpoint.hpp:849
void init_asio()
Initialize asio transport with internal io_service.
Definition: endpoint.hpp:249
config::elog_type elog_type
Type of the error logging policy.
Definition: endpoint.hpp:64
void init_logging(const lib::shared_ptr< alog_type > &a, const lib::shared_ptr< elog_type > &e)
Initialize logging.
Definition: endpoint.hpp:823
bool is_secure() const
Return whether or not the endpoint produces secure connections.
Definition: endpoint.hpp:172
void init_asio(io_service_ptr ptr)
initialize asio transport with external io_service
Definition: endpoint.hpp:212
lib::asio::ip::tcp::endpoint get_local_endpoint(lib::asio::error_code &ec)
Get local TCP endpoint.
Definition: endpoint.hpp:395
void set_reuse_addr(bool value)
Sets whether to use the SO_REUSEADDR flag when opening listening sockets.
Definition: endpoint.hpp:363
void set_tcp_init_handler(tcp_init_handler h)
Sets the tcp pre init handler (deprecated)
Definition: endpoint.hpp:302
void handle_timer(timer_ptr, timer_handler callback, lib::asio::error_code const &ec)
Timer handler.
Definition: endpoint.hpp:745
void start_perpetual()
Marks the endpoint as perpetual, stopping it from exiting when empty.
Definition: endpoint.hpp:689
void stop()
wraps the stop method of the internal io_service object
Definition: endpoint.hpp:653
std::size_t run()
wraps the run method of the internal io_service object
Definition: endpoint.hpp:640
void set_tcp_post_init_handler(tcp_init_handler h)
Sets the tcp post init handler.
Definition: endpoint.hpp:317
void set_listen_backlog(int backlog)
Sets the maximum length of the queue of pending connections.
Definition: endpoint.hpp:342
bool stopped() const
wraps the stopped method of the internal io_service object
Definition: endpoint.hpp:673
timer_ptr set_timer(long duration, timer_handler callback)
Call back a function after a period of time.
Definition: endpoint.hpp:717
void init_asio(io_service_ptr ptr, lib::error_code &ec)
initialize asio transport with external io_service (exception free)
Definition: endpoint.hpp:185
socket_con_type::ptr socket_con_ptr
Type of a shared pointer to the socket connection component.
Definition: endpoint.hpp:71
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
Definition: endpoint.hpp:1113
asio::connection< config > transport_con_type
Definition: endpoint.hpp:75
void init_asio(lib::error_code &ec)
Initialize asio transport with internal io_service (exception free)
Definition: endpoint.hpp:227
void async_accept(transport_con_ptr tcon, accept_handler callback)
Accept the next connection attempt and assign it to con.
Definition: endpoint.hpp:807
void listen(uint16_t port)
Set up endpoint for listening on a port.
Definition: endpoint.hpp:536
void listen(std::string const &host, std::string const &service, lib::error_code &ec)
Set up endpoint for listening on a host and service (exception free)
Definition: endpoint.hpp:556
endpoint< config > type
Type of this endpoint transport component.
Definition: endpoint.hpp:57
lib::asio::io_service & get_io_service()
Retrieve a reference to the endpoint's io_service.
Definition: endpoint.hpp:378
config::concurrency_type concurrency_type
Type of the concurrency policy.
Definition: endpoint.hpp:60
std::size_t poll()
wraps the poll method of the internal io_service object
Definition: endpoint.hpp:658
void stop_perpetual()
Clears the endpoint's perpetual flag, allowing it to exit when empty.
Definition: endpoint.hpp:701
lib::shared_ptr< lib::asio::ip::tcp::acceptor > acceptor_ptr
Type of a shared pointer to the acceptor being used.
Definition: endpoint.hpp:83
void listen(lib::asio::ip::tcp::endpoint const &ep)
Set up endpoint for listening manually.
Definition: endpoint.hpp:460
void handle_resolve_timeout(timer_ptr, connect_handler callback, lib::error_code const &ec)
DNS resolution timeout handler.
Definition: endpoint.hpp:944
void listen(lib::asio::ip::tcp::endpoint const &ep, lib::error_code &ec)
Set up endpoint for listening manually (exception free)
Definition: endpoint.hpp:412
transport_con_type::ptr transport_con_ptr
Definition: endpoint.hpp:78
lib::shared_ptr< lib::asio::io_service::work > work_ptr
Type of a shared pointer to an io_service work object.
Definition: endpoint.hpp:89
void reset()
wraps the reset method of the internal io_service object
Definition: endpoint.hpp:668
void set_tcp_pre_bind_handler(tcp_pre_bind_handler h)
Sets the tcp pre bind handler.
Definition: endpoint.hpp:274
config::alog_type alog_type
Type of the access logging policy.
Definition: endpoint.hpp:66
lib::asio::io_service * io_service_ptr
Type of a pointer to the ASIO io_service being used.
Definition: endpoint.hpp:81
void listen(InternetProtocol const &internet_protocol, uint16_t port)
Set up endpoint for listening with protocol and port.
Definition: endpoint.hpp:502
void set_tcp_pre_init_handler(tcp_init_handler h)
Sets the tcp pre init handler.
Definition: endpoint.hpp:288
void listen(std::string const &host, std::string const &service)
Set up endpoint for listening on a host and service.
Definition: endpoint.hpp:589
void handle_connect_timeout(transport_con_ptr tcon, timer_ptr, connect_handler callback, lib::error_code const &ec)
Asio connect timeout handler.
Definition: endpoint.hpp:1053
void async_accept(transport_con_ptr tcon, accept_handler callback, lib::error_code &ec)
Accept the next connection attempt and assign it to con (exception free)
Definition: endpoint.hpp:768
std::size_t poll_one()
wraps the poll_one method of the internal io_service object
Definition: endpoint.hpp:663
void listen(InternetProtocol const &internet_protocol, uint16_t port, lib::error_code &ec)
Set up endpoint for listening with protocol and port (exception free)
Definition: endpoint.hpp:481
void listen(uint16_t port, lib::error_code &ec)
Set up endpoint for listening on a port (exception free)
Definition: endpoint.hpp:520
bool is_listening() const
Check if the endpoint is listening.
Definition: endpoint.hpp:635
void stop_listening()
Stop listening.
Definition: endpoint.hpp:625
lib::shared_ptr< lib::asio::ip::tcp::resolver > resolver_ptr
Type of a shared pointer to the resolver being used.
Definition: endpoint.hpp:85
lib::function< lib::error_code(acceptor_ptr)> tcp_pre_bind_handler
Type of socket pre-bind handler.
Definition: endpoint.hpp:92
Asio transport error category.
Definition: base.hpp:184
Error category related to asio transport socket policies.
Definition: base.hpp:110
lib::shared_ptr< type > ptr
Type of a shared pointer to this connection transport component.
Definition: connection.hpp:65
connection_hdl get_handle() const
Get the connection handle.
Definition: connection.hpp:313
config::alog_type alog_type
Type of this transport's access logging policy.
Definition: connection.hpp:70
lib::error_code dispatch(dispatch_handler handler)
Call given handler back within the transport's event system (if present)
Definition: connection.hpp:580
void async_shutdown(transport::shutdown_handler handler)
Perform cleanup on socket shutdown_handler.
Definition: connection.hpp:593
void set_write_handler(write_handler h)
Sets the write handler.
Definition: connection.hpp:350
void set_secure(bool value)
Set whether or not this connection is secure.
Definition: connection.hpp:257
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition: connection.hpp:400
connection< config > type
Type of this connection transport component.
Definition: connection.hpp:63
config::elog_type elog_type
Type of this transport's error logging policy.
Definition: connection.hpp:72
void fatal_error()
Signal transport error.
Definition: connection.hpp:235
size_t read_some(char const *buf, size_t len)
Manual input supply (read some)
Definition: connection.hpp:165
size_t read_all(char const *buf, size_t len)
Manual input supply (read all)
Definition: connection.hpp:188
void async_write(char const *buf, size_t len, transport::write_handler handler)
Asyncronous Transport Write.
Definition: connection.hpp:487
size_t readsome(char const *buf, size_t len)
Manual input supply (DEPRECATED)
Definition: connection.hpp:208
config::concurrency_type concurrency_type
transport concurrency policy
Definition: connection.hpp:68
void init(init_handler handler)
Initialize the connection transport.
Definition: connection.hpp:410
timer_ptr set_timer(long, timer_handler)
Call back a function after a period of time.
Definition: connection.hpp:327
void set_remote_endpoint(std::string value)
Set human readable remote endpoint address.
Definition: connection.hpp:289
friend std::istream & operator>>(std::istream &in, type &t)
Overloaded stream input operator.
Definition: connection.hpp:142
void set_vector_write_handler(vector_write_handler h)
Sets the vectored write handler.
Definition: connection.hpp:380
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition: connection.hpp:271
std::string get_remote_endpoint() const
Get human readable remote endpoint address.
Definition: connection.hpp:305
void set_handle(connection_hdl hdl)
Set Connection Handle.
Definition: connection.hpp:565
void register_ostream(std::ostream *o)
Register a std::ostream with the transport for writing output.
Definition: connection.hpp:104
void async_read_at_least(size_t num_bytes, char *buf, size_t len, read_handler handler)
Initiate an async_read for at least num_bytes bytes into buf.
Definition: connection.hpp:439
void async_write(std::vector< buffer > const &bufs, transport::write_handler handler)
Asyncronous Transport Write (scatter-gather)
Definition: connection.hpp:527
ptr get_shared()
Get a shared pointer to this component.
Definition: connection.hpp:93
iostream::connection< config > transport_con_type
Definition: endpoint.hpp:62
config::elog_type elog_type
Type of this endpoint's error logging policy.
Definition: endpoint.hpp:56
void set_write_handler(write_handler h)
Sets the write handler.
Definition: endpoint.hpp:134
void set_shutdown_handler(shutdown_handler h)
Sets the shutdown handler.
Definition: endpoint.hpp:154
bool is_secure() const
Tests whether or not the underlying transport is secure.
Definition: endpoint.hpp:116
lib::shared_ptr< type > ptr
Type of a pointer to this endpoint transport component.
Definition: endpoint.hpp:51
transport_con_type::ptr transport_con_ptr
Definition: endpoint.hpp:65
void async_connect(transport_con_ptr, uri_ptr, connect_handler cb)
Initiate a new connection.
Definition: endpoint.hpp:183
lib::error_code init(transport_con_ptr tcon)
Initialize a connection.
Definition: endpoint.hpp:197
void init_logging(lib::shared_ptr< alog_type > a, lib::shared_ptr< elog_type > e)
Initialize logging.
Definition: endpoint.hpp:171
endpoint type
Type of this endpoint transport component.
Definition: endpoint.hpp:49
void register_ostream(std::ostream *o)
Register a default output stream.
Definition: endpoint.hpp:80
config::concurrency_type concurrency_type
Type of this endpoint's concurrency policy.
Definition: endpoint.hpp:54
void set_secure(bool value)
Set whether or not endpoint can create secure connections.
Definition: endpoint.hpp:102
config::alog_type alog_type
Type of this endpoint's access logging policy.
Definition: endpoint.hpp:58
iostream transport error category
Definition: base.hpp:85
std::string get_query() const
Return the query portion.
Definition: uri.hpp:294
Provides streaming UTF8 validation functionality.
bool decode(iterator_type begin, iterator_type end)
Advance validator state with input from an iterator pair.
validator()
Construct and initialize the validator.
bool complete()
Return whether the input sequence ended on a valid utf8 codepoint.
void reset()
Reset the validator to decode another message.
bool consume(uint8_t byte)
Advance the state of the validator with the next input byte.
#define _WEBSOCKETPP_CONSTEXPR_TOKEN_
Definition: cpp11.hpp:132
#define _WEBSOCKETPP_NOEXCEPT_TOKEN_
Definition: cpp11.hpp:113
#define __has_extension
Definition: cpp11.hpp:40
#define __has_feature(x)
Definition: cpp11.hpp:37
#define ZSW_MD5_BYTE_ORDER
Definition: md5.hpp:101
#define ZSW_MD5_T54
Definition: md5.hpp:158
#define ZSW_MD5_T40
Definition: md5.hpp:144
#define ZSW_MD5_T55
Definition: md5.hpp:159
#define ZSW_MD5_T29
Definition: md5.hpp:133
#define ZSW_MD5_T37
Definition: md5.hpp:141
#define ZSW_MD5_T5
Definition: md5.hpp:109
#define ZSW_MD5_T44
Definition: md5.hpp:148
#define ZSW_MD5_T52
Definition: md5.hpp:156
#define ZSW_MD5_T20
Definition: md5.hpp:124
#define ZSW_MD5_T26
Definition: md5.hpp:130
#define ZSW_MD5_T33
Definition: md5.hpp:137
#define ZSW_MD5_T8
Definition: md5.hpp:112
#define ZSW_MD5_T36
Definition: md5.hpp:140
#define ZSW_MD5_H(x, y, z)
#define ZSW_MD5_T50
Definition: md5.hpp:154
#define ZSW_MD5_T61
Definition: md5.hpp:165
#define ZSW_MD5_T12
Definition: md5.hpp:116
#define ZSW_MD5_I(x, y, z)
#define ZSW_MD5_T_MASK
Definition: md5.hpp:104
#define ZSW_MD5_T35
Definition: md5.hpp:139
#define ZSW_MD5_T63
Definition: md5.hpp:167
#define ZSW_MD5_T1
Definition: md5.hpp:105
#define ZSW_MD5_T53
Definition: md5.hpp:157
#define ZSW_MD5_T41
Definition: md5.hpp:145
#define ZSW_MD5_T60
Definition: md5.hpp:164
#define ZSW_MD5_T11
Definition: md5.hpp:115
#define ZSW_MD5_T39
Definition: md5.hpp:143
#define ZSW_MD5_T21
Definition: md5.hpp:125
#define ZSW_MD5_T2
Definition: md5.hpp:106
#define ZSW_MD5_T16
Definition: md5.hpp:120
#define ZSW_MD5_T57
Definition: md5.hpp:161
#define ZSW_MD5_T32
Definition: md5.hpp:136
#define SET(a, b, c, d, k, s, Ti)
#define ZSW_MD5_T47
Definition: md5.hpp:151
#define ZSW_MD5_T28
Definition: md5.hpp:132
#define ZSW_MD5_T46
Definition: md5.hpp:150
#define ZSW_MD5_T58
Definition: md5.hpp:162
#define ZSW_MD5_T62
Definition: md5.hpp:166
#define ZSW_MD5_T13
Definition: md5.hpp:117
#define ZSW_MD5_T7
Definition: md5.hpp:111
#define ZSW_MD5_T31
Definition: md5.hpp:135
#define ZSW_MD5_T6
Definition: md5.hpp:110
#define ZSW_MD5_G(x, y, z)
#define ZSW_MD5_T48
Definition: md5.hpp:152
#define ZSW_MD5_T15
Definition: md5.hpp:119
#define ZSW_MD5_T43
Definition: md5.hpp:147
#define ZSW_MD5_T10
Definition: md5.hpp:114
#define ZSW_MD5_T34
Definition: md5.hpp:138
#define ZSW_MD5_T4
Definition: md5.hpp:108
#define ZSW_MD5_T22
Definition: md5.hpp:126
#define ZSW_MD5_T64
Definition: md5.hpp:168
#define ZSW_MD5_T14
Definition: md5.hpp:118
#define ZSW_MD5_T25
Definition: md5.hpp:129
#define ZSW_MD5_T38
Definition: md5.hpp:142
#define ZSW_MD5_T3
Definition: md5.hpp:107
#define ZSW_MD5_T45
Definition: md5.hpp:149
#define ZSW_MD5_T17
Definition: md5.hpp:121
#define ZSW_MD5_T24
Definition: md5.hpp:128
#define ZSW_MD5_F(x, y, z)
#define ZSW_MD5_T59
Definition: md5.hpp:163
#define ZSW_MD5_T18
Definition: md5.hpp:122
#define ZSW_MD5_T9
Definition: md5.hpp:113
#define ZSW_MD5_T27
Definition: md5.hpp:131
#define ZSW_MD5_T56
Definition: md5.hpp:160
#define ZSW_MD5_T23
Definition: md5.hpp:127
#define ZSW_MD5_T19
Definition: md5.hpp:123
#define ZSW_MD5_T30
Definition: md5.hpp:134
#define ZSW_MD5_T51
Definition: md5.hpp:155
#define ZSW_MD5_ROTATE_LEFT(x, n)
#define ZSW_MD5_T49
Definition: md5.hpp:153
#define ZSW_MD5_T42
Definition: md5.hpp:146
A package of types and methods for manipulating WebSocket close status'.
Definition: close.hpp:47
static value const service_restart
Definition: close.hpp:138
static value const message_too_big
An endpoint received a message too large to process.
Definition: close.hpp:121
static value const try_again_later
Definition: close.hpp:143
static value const force_tcp_drop
Close the connection with a forced TCP drop.
Definition: close.hpp:72
static value const tls_handshake
An endpoint failed to perform a TLS handshake.
Definition: close.hpp:157
static value const rsv_end
Last value in range reserved for future protocol use.
Definition: close.hpp:177
static value const invalid_payload
An endpoint received message data inconsistent with its type.
Definition: close.hpp:110
bool terminal(value code)
Determine if the code represents an unrecoverable error.
Definition: close.hpp:217
static value const protocol_error
A protocol error occurred.
Definition: close.hpp:83
std::string get_string(value code)
Return a human readable interpretation of a WebSocket close code.
Definition: close.hpp:232
static value const bad_gateway
Definition: close.hpp:148
static value const invalid_subprotocol_data
A invalid subprotocol data.
Definition: close.hpp:172
static value const invalid_high
Last value in range that is always invalid on the wire.
Definition: close.hpp:192
static value const unsupported_data
Definition: close.hpp:91
static value const no_status
A dummy value to indicate that no status code was received.
Definition: close.hpp:97
static value const omit_handshake
Close the connection without a WebSocket close handshake.
Definition: close.hpp:62
static value const normal
Definition: close.hpp:76
static value const blank
A blank value for internal use.
Definition: close.hpp:52
static value const invalid_low
First value in range that is always invalid on the wire.
Definition: close.hpp:190
static value const abnormal_close
A dummy value to indicate that the connection was closed abnormally.
Definition: close.hpp:104
static value const rsv_start
First value in range reserved for future protocol use.
Definition: close.hpp:175
uint16_t value
The type of a close code value.
Definition: close.hpp:49
static value const policy_violation
An endpoint received a message that violated its policy.
Definition: close.hpp:118
static value const extension_required
A client expected the server to accept a required extension request.
Definition: close.hpp:129
bool invalid(value code)
Test whether a close code is invalid on the wire.
Definition: close.hpp:199
static value const internal_endpoint_error
Definition: close.hpp:133
static value const subprotocol_error
A generic subprotocol error.
Definition: close.hpp:165
bool reserved(value code)
Test whether a close code is in a reserved range.
Definition: close.hpp:184
static value const going_away
Definition: close.hpp:80
A package of types and methods for manipulating WebSocket close codes.
Definition: close.hpp:45
std::string extract_reason(std::string const &payload, lib::error_code &ec)
Extract the reason string from a close payload.
Definition: close.hpp:333
status::value extract_code(std::string const &payload, lib::error_code &ec)
Extract a close code value from a close payload.
Definition: close.hpp:294
Concurrency handling support.
Definition: basic.hpp:34
Library level error codes.
Definition: error.hpp:44
@ general
Catch-all library error.
Definition: error.hpp:47
@ unrequested_subprotocol
Selected subprotocol was not requested by the client.
Definition: error.hpp:102
@ invalid_port
Invalid port in URI.
Definition: error.hpp:120
@ client_only
Attempted to use a client specific feature on a server endpoint.
Definition: error.hpp:105
@ http_connection_ended
HTTP connection ended.
Definition: error.hpp:111
@ async_accept_not_listening
Definition: error.hpp:124
@ operation_canceled
The requested operation was canceled.
Definition: error.hpp:127
@ no_outgoing_buffers
The endpoint is out of outgoing message buffers.
Definition: error.hpp:68
@ http_parse_error
HTTP parse error.
Definition: error.hpp:143
@ reserved_close_code
Close code is in a reserved range.
Definition: error.hpp:80
@ con_creation_failed
Connection creation attempted failed.
Definition: error.hpp:99
@ no_incoming_buffers
The endpoint is out of incoming message buffers.
Definition: error.hpp:71
@ invalid_state
The connection was in the wrong state for this operation.
Definition: error.hpp:74
@ extension_neg_failed
Extension negotiation failed.
Definition: error.hpp:146
@ rejected
Connection rejected.
Definition: error.hpp:130
@ unsupported_version
Unsupported WebSocket protocol version.
Definition: error.hpp:140
@ invalid_utf8
Invalid UTF-8.
Definition: error.hpp:86
@ invalid_close_code
Close code is invalid.
Definition: error.hpp:83
@ server_only
Attempted to use a server specific feature on a client endpoint.
Definition: error.hpp:108
@ endpoint_not_secure
Attempted to open a secure connection with an insecure endpoint.
Definition: error.hpp:57
@ close_handshake_timeout
WebSocket close handshake timed out.
Definition: error.hpp:117
@ invalid_subprotocol
Invalid subprotocol.
Definition: error.hpp:89
@ bad_close_code
Unable to parse close code.
Definition: error.hpp:77
@ open_handshake_timeout
WebSocket opening handshake timed out.
Definition: error.hpp:114
@ invalid_version
Invalid WebSocket protocol version.
Definition: error.hpp:137
@ send_queue_full
send attempted when endpoint write queue was full
Definition: error.hpp:50
@ test
Unit testing utility error code.
Definition: error.hpp:96
@ invalid_uri
An invalid uri was supplied.
Definition: error.hpp:65
Implementation of RFC 7692, the permessage-deflate WebSocket extension.
Definition: disabled.hpp:44
Constants related to frame and payload limits.
Definition: frame.hpp:145
static uint8_t const close_reason_size
Maximum size of close frame reason.
Definition: frame.hpp:169
static uint64_t const payload_size_jumbo
Maximum size of a jumbo WebSocket payload (basic payload = 127)
Definition: frame.hpp:162
static unsigned int const max_extended_header_length
Maximum length of the variable portion of the WebSocket header.
Definition: frame.hpp:153
static unsigned int const max_header_length
Maximum length of a WebSocket header.
Definition: frame.hpp:150
static uint16_t const payload_size_extended
Maximum size of an extended WebSocket payload (basic payload = 126)
Definition: frame.hpp:159
static uint8_t const payload_size_basic
Maximum size of a basic WebSocket payload.
Definition: frame.hpp:156
static unsigned int const basic_header_length
Minimum length of a WebSocket frame header.
Definition: frame.hpp:147
Constants and utility functions related to WebSocket opcodes.
Definition: frame.hpp:76
bool invalid(value v)
Check if an opcode is invalid.
Definition: frame.hpp:130
bool reserved(value v)
Check if an opcode is reserved.
Definition: frame.hpp:118
bool is_control(value v)
Check if an opcode is for a control frame.
Definition: frame.hpp:139
Data structures and utility functions for manipulating WebSocket frames.
Definition: frame.hpp:45
unsigned int get_masking_key_offset(basic_header const &)
Calculate the offset location of the masking key within the extended header.
Definition: frame.hpp:469
void set_rsv2(basic_header &h, bool value)
Set the frame's RSV2 bit.
Definition: frame.hpp:366
static unsigned int const MAX_HEADER_LENGTH
Maximum length of a WebSocket header.
Definition: frame.hpp:50
opcode::value get_opcode(basic_header const &h)
Extract opcode from basic header.
Definition: frame.hpp:393
void set_rsv3(basic_header &h, bool value)
Set the frame's RSV3 bit.
Definition: frame.hpp:384
uint64_t get_payload_size(basic_header const &, extended_header const &)
Extract the full payload size field from a WebSocket header.
Definition: frame.hpp:573
uint8_t get_basic_size(basic_header const &)
Extracts the raw payload length specified in the basic header.
Definition: frame.hpp:431
size_t byte_mask_circ(uint8_t *input, uint8_t *output, size_t length, size_t prepared_key)
Circular byte aligned mask/unmask.
Definition: frame.hpp:830
void byte_mask(input_iter b, input_iter e, output_iter o, masking_key_type const &key, size_t key_offset=0)
Byte by byte mask/unmask.
Definition: frame.hpp:645
static unsigned int const MAX_EXTENDED_HEADER_LENGTH
Maximum length of the variable portion of the WebSocket header.
Definition: frame.hpp:52
bool get_rsv3(basic_header const &h)
check whether the frame's RSV3 bit is set
Definition: frame.hpp:375
bool get_masked(basic_header const &h)
check whether the frame is masked
Definition: frame.hpp:402
bool get_rsv2(basic_header const &h)
check whether the frame's RSV2 bit is set
Definition: frame.hpp:357
void byte_mask(iter_type b, iter_type e, masking_key_type const &key, size_t key_offset=0)
Byte by byte mask/unmask (in place)
Definition: frame.hpp:675
uint16_t get_extended_size(extended_header const &)
Extract the extended size field from an extended header.
Definition: frame.hpp:540
size_t byte_mask_circ(uint8_t *data, size_t length, size_t prepared_key)
Circular byte aligned mask/unmask (in place)
Definition: frame.hpp:857
bool get_fin(basic_header const &h)
Check whether the frame's FIN bit is set.
Definition: frame.hpp:321
size_t circshift_prepared_key(size_t prepared_key, size_t offset)
circularly shifts the supplied prepared masking key by offset bytes
Definition: frame.hpp:612
bool get_rsv1(basic_header const &h)
check whether the frame's RSV1 bit is set
Definition: frame.hpp:339
void set_masked(basic_header &h, bool value)
Set the frame's MASK bit.
Definition: frame.hpp:411
size_t word_mask_circ(uint8_t *input, uint8_t *output, size_t length, size_t prepared_key)
Circular word aligned mask/unmask.
Definition: frame.hpp:768
void word_mask_exact(uint8_t *data, size_t length, masking_key_type const &key)
Exact word aligned mask/unmask (in place)
Definition: frame.hpp:731
void set_rsv1(basic_header &h, bool value)
Set the frame's RSV1 bit.
Definition: frame.hpp:348
size_t get_header_len(basic_header const &)
Calculates the full length of the header based on the first bytes.
Definition: frame.hpp:445
void set_fin(basic_header &h, bool value)
Set the frame's FIN bit.
Definition: frame.hpp:330
uint64_t get_jumbo_size(extended_header const &)
Extract the jumbo size field from an extended header.
Definition: frame.hpp:555
void word_mask_exact(uint8_t *input, uint8_t *output, size_t length, masking_key_type const &key)
Exact word aligned mask/unmask.
Definition: frame.hpp:702
std::string prepare_header(const basic_header &h, const extended_header &e)
Generate a properly sized contiguous string that encodes a full frame header.
Definition: frame.hpp:489
masking_key_type get_masking_key(basic_header const &, extended_header const &)
Extract the masking key from a frame header.
Definition: frame.hpp:516
static unsigned int const BASIC_HEADER_LENGTH
Minimum length of a WebSocket frame header.
Definition: frame.hpp:48
size_t word_mask_circ(uint8_t *data, size_t length, size_t prepared_key)
Circular word aligned mask/unmask (in place)
Definition: frame.hpp:805
size_t prepare_masking_key(masking_key_type const &key)
Extract a masking key into a value the size of a machine word.
Definition: frame.hpp:595
HTTP handling support.
Definition: request.hpp:37
size_t const max_body_size
Default Maximum size in bytes for HTTP message bodies.
Definition: constants.hpp:68
static char const header_separator[]
Literal value of the HTTP header separator.
Definition: constants.hpp:59
std::vector< std::pair< std::string, attribute_list > > parameter_list
The type of an HTTP parameter list.
Definition: constants.hpp:53
size_t const istream_buffer
Number of bytes to use for temporary istream read buffers.
Definition: constants.hpp:71
bool is_not_token_char(unsigned char c)
Is the character a non-token.
Definition: constants.hpp:103
size_t const max_header_size
Maximum size in bytes before rejecting an HTTP header as too big.
Definition: constants.hpp:65
static char const header_delimiter[]
Literal value of the HTTP header delimiter.
Definition: constants.hpp:56
bool is_whitespace_char(unsigned char c)
Is the character whitespace.
Definition: constants.hpp:111
static char const header_token[]
invalid HTTP token characters
Definition: constants.hpp:78
bool is_not_whitespace_char(unsigned char c)
Is the character non-whitespace.
Definition: constants.hpp:116
std::map< std::string, std::string > attribute_list
The type of an HTTP attribute list.
Definition: constants.hpp:45
bool is_token_char(unsigned char c)
Is the character a token.
Definition: constants.hpp:98
static std::string const empty_header
Literal value of an empty header.
Definition: constants.hpp:62
Provides MD5 hashing functionality.
Definition: md5.hpp:76
Constants related to processing WebSocket connections.
Definition: base.hpp:44
Processor class related error codes.
Definition: base.hpp:54
Error code category and codes used by all processor types.
Definition: base.hpp:65
lib::error_category const & get_processor_category()
Get a reference to a static copy of the processor error category.
Definition: base.hpp:238
close::status::value to_ws(lib::error_code ec)
Converts a processor error_code into a websocket close code.
Definition: base.hpp:261
@ missing_required_header
Missing Required Header.
Definition: base.hpp:129
@ control_too_big
Control frame too large.
Definition: base.hpp:90
@ invalid_http_method
Invalid HTTP method.
Definition: base.hpp:120
@ invalid_rsv_bit
Illegal use of reserved bit.
Definition: base.hpp:93
@ reason_requires_code
Using a reason requires a close code.
Definition: base.hpp:144
@ invalid_close_code
Invalid close code used.
Definition: base.hpp:141
@ masking_required
Clients may not send unmasked frames.
Definition: base.hpp:102
@ protocol_violation
Processor encountered a protocol violation in an incoming message.
Definition: base.hpp:75
@ extensions_disabled
Extension related operation was ignored because extensions are disabled.
Definition: base.hpp:153
@ reserved_close_code
Reserved close code used.
Definition: base.hpp:138
@ extension_parse_error
Error parsing extensions.
Definition: base.hpp:150
@ masking_forbidden
Servers may not send masked frames.
Definition: base.hpp:105
@ not_implemented
Operation required not implemented functionality.
Definition: base.hpp:117
@ invalid_opcode
Opcode was invalid for requested operation.
Definition: base.hpp:87
@ sha1_library
Embedded SHA-1 library error.
Definition: base.hpp:132
@ requires_64bit
Not supported on 32 bit systems.
Definition: base.hpp:111
@ subprotocol_parse_error
Error parsing subprotocols.
Definition: base.hpp:147
@ bad_request
Error was the result of improperly formatted user input.
Definition: base.hpp:72
@ invalid_utf8
Invalid UTF-8 encoding.
Definition: base.hpp:114
@ invalid_http_status
Invalid HTTP status.
Definition: base.hpp:126
@ invalid_payload
Processor encountered invalid payload data.
Definition: base.hpp:81
@ invalid_http_version
Invalid HTTP version.
Definition: base.hpp:123
@ message_too_big
Processor encountered a message that was too large.
Definition: base.hpp:78
@ no_protocol_support
No support for this feature in this protocol version.
Definition: base.hpp:135
@ invalid_arguments
The processor method was called with invalid arguments.
Definition: base.hpp:84
@ invalid_continuation
Continuation without message.
Definition: base.hpp:99
@ non_minimal_encoding
Payload length not minimally encoded.
Definition: base.hpp:108
@ fragmented_control
Fragmented control message.
Definition: base.hpp:96
lib::error_code make_error_code(error::processor_errors e)
Create an error code with the given value and the processor category.
Definition: base.hpp:244
Processors encapsulate the protocol rules specific to each WebSocket version.
Definition: processor.hpp:59
int get_websocket_version(request_type &r)
Extract the version from a WebSocket handshake request.
Definition: processor.hpp:107
uri_ptr get_uri_from_host(request_type &request, std::string scheme)
Extract a URI ptr from the host header of the request.
Definition: processor.hpp:136
bool is_websocket_handshake(request_type &r)
Determine whether or not a generic HTTP request is a WebSocket handshake.
Definition: processor.hpp:68
Stub RNG policy that always returns 0.
Definition: none.hpp:35
Random number generation policies.
lib::function< void(connection_hdl, lib::asio::ip::tcp::socket &)> socket_init_handler
The signature of the socket init handler for this socket policy.
Definition: none.hpp:51
Asio transport errors.
Definition: base.hpp:161
lib::error_category const & get_category()
Get a reference to a static copy of the asio transport error category.
Definition: base.hpp:211
lib::error_code make_error_code(error::value e)
Create an error code with the given value and the asio transport category.
Definition: base.hpp:217
@ proxy_invalid
Invalid Proxy URI.
Definition: base.hpp:177
@ pass_through
there was an error in the underlying transport library
Definition: base.hpp:171
@ proxy_failed
The connection to the requested proxy server failed.
Definition: base.hpp:174
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition: base.hpp:168
@ invalid_host_service
Invalid host or service.
Definition: base.hpp:180
Errors related to asio transport sockets.
Definition: base.hpp:75
@ missing_tls_init_handler
Required tls_init handler not present.
Definition: base.hpp:99
@ invalid_state
A function was called in a state that it was illegal to do so.
Definition: base.hpp:86
@ tls_failed_sni_hostname
Failed to set TLS SNI hostname.
Definition: base.hpp:105
@ tls_handshake_failed
TLS Handshake Failed.
Definition: base.hpp:102
@ tls_handshake_timeout
TLS Handshake Timeout.
Definition: base.hpp:93
@ pass_through
pass_through from underlying library
Definition: base.hpp:96
Transport policy that uses asio.
Definition: endpoint.hpp:46
Generic transport related errors.
Definition: connection.hpp:146
@ pass_through
underlying transport pass through
Definition: connection.hpp:153
@ operation_not_supported
Operation not supported.
Definition: connection.hpp:165
@ operation_aborted
Operation aborted.
Definition: connection.hpp:162
@ tls_error
Other TLS error.
Definition: connection.hpp:180
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition: connection.hpp:156
@ action_after_shutdown
read or write after shutdown
Definition: connection.hpp:177
@ tls_short_read
TLS short read.
Definition: connection.hpp:171
@ double_read
async_read called while another async_read was in progress
Definition: connection.hpp:159
iostream transport errors
Definition: base.hpp:64
@ invalid_num_bytes
async_read_at_least call requested more bytes than buffer can store
Definition: base.hpp:71
@ double_read
async_read called while another async_read was in progress
Definition: base.hpp:74
lib::error_code make_error_code(error::value e)
Get an error code with the given value and the iostream transport category.
Definition: base.hpp:118
lib::error_category const & get_category()
Get a reference to a static copy of the iostream transport error category.
Definition: base.hpp:112
Transport policy that uses STL iostream for I/O and does not support timers.
Definition: endpoint.hpp:43
lib::function< lib::error_code(connection_hdl, std::vector< transport::buffer > const &bufs)> vector_write_handler
Definition: base.hpp:57
lib::function< lib::error_code(connection_hdl)> shutdown_handler
Definition: base.hpp:61
lib::function< lib::error_code(connection_hdl, char const *, size_t)> write_handler
The type and signature of the callback used by iostream transport to write.
Definition: base.hpp:48
Transport policies provide network connectivity and timers.
Definition: endpoint.hpp:45
lib::function< void(lib::error_code const &, size_t)> read_handler
The type and signature of the callback passed to the read method.
Definition: connection.hpp:120
lib::function< void()> dispatch_handler
The type and signature of the callback passed to the dispatch method.
Definition: connection.hpp:135
lib::function< void()> interrupt_handler
The type and signature of the callback passed to the interrupt method.
Definition: connection.hpp:132
lib::function< void(lib::error_code const &)> accept_handler
The type and signature of the callback passed to the accept method.
Definition: endpoint.hpp:69
lib::function< void(lib::error_code const &)> timer_handler
The type and signature of the callback passed to the read method.
Definition: connection.hpp:126
lib::function< void(lib::error_code const &)> connect_handler
The type and signature of the callback passed to the connect method.
Definition: endpoint.hpp:72
lib::function< void(lib::error_code const &)> write_handler
The type and signature of the callback passed to the write method.
Definition: connection.hpp:123
lib::function< void(lib::error_code const &)> init_handler
The type and signature of the callback passed to the init hook.
Definition: connection.hpp:117
lib::function< void(lib::error_code const &)> shutdown_handler
The type and signature of the callback passed to the shutdown method.
Definition: connection.hpp:129
Generic non-websocket specific utility functions and data structures.
Definition: utilities.hpp:39
std::string to_hex(std::string const &input)
Convert std::string to ascii printed string of hex digits.
std::string to_hex(uint8_t const *input, size_t length)
Convert byte array (uint8_t) to ascii printed string of hex digits.
T::const_iterator ci_find_substr(T const &haystack, T const &needle, std::locale const &loc=std::locale())
Find substring (case insensitive)
Definition: utilities.hpp:101
std::string string_replace_all(std::string subject, std::string const &search, std::string const &replace)
Replace all occurrances of a substring with another.
T::const_iterator ci_find_substr(T const &haystack, typename T::value_type const *needle, typename T::size_type size, std::locale const &loc=std::locale())
Find substring (case insensitive)
Definition: utilities.hpp:123
std::string to_hex(char const *input, size_t length)
Convert char array to ascii printed string of hex digits.
std::string to_lower(std::string const &in)
Convert a string to lowercase.
Namespace for the WebSocket++ project.
std::string base64_decode(std::string const &input)
Decode a base64 encoded string into a string of raw bytes.
Definition: base64.hpp:131
lib::function< void(connection_hdl, std::string)> pong_handler
The type and function signature of a pong handler.
Definition: connection.hpp:109
lib::function< void(connection_hdl)> close_handler
The type and function signature of a close handler.
Definition: connection.hpp:69
lib::function< void(connection_hdl, std::string)> pong_timeout_handler
The type and function signature of a pong timeout handler.
Definition: connection.hpp:116
lib::function< void(connection_hdl)> http_handler
The type and function signature of a http handler.
Definition: connection.hpp:151
std::string base64_encode(std::string const &input)
Encode a string into a base64 string.
Definition: base64.hpp:119
lib::function< void(connection_hdl)> open_handler
The type and function signature of an open handler.
Definition: connection.hpp:59
lib::function< void(connection_hdl)> interrupt_handler
The type and function signature of an interrupt handler.
Definition: connection.hpp:91
static uint16_t const uri_default_secure_port
Default port for wss://.
Definition: uri.hpp:47
lib::function< void(connection_hdl)> fail_handler
The type and function signature of a fail handler.
Definition: connection.hpp:79
lib::weak_ptr< void > connection_hdl
A handle to uniquely identify a connection.
static uint16_t const uri_default_port
Default port for ws://.
Definition: uri.hpp:45
lib::function< bool(connection_hdl, std::string)> ping_handler
The type and function signature of a ping handler.
Definition: connection.hpp:101
lib::shared_ptr< uri > uri_ptr
Pointer to a URI.
Definition: uri.hpp:352
std::pair< lib::error_code, std::string > err_str_pair
Combination error code / string type for returning two values.
Definition: error.hpp:41
lib::function< bool(connection_hdl)> validate_handler
The type and function signature of a validate handler.
Definition: connection.hpp:129
static bool is_base64(unsigned char c)
Test whether a character is a valid base64 character.
Definition: base64.hpp:53
std::string base64_encode(unsigned char const *input, size_t len)
Encode a char buffer into a base64 string.
Definition: base64.hpp:66
#define TYP_BIGE
Definition: network.hpp:53
#define TYP_SMLE
Definition: network.hpp:52
#define TYP_INIT
Definition: network.hpp:51
#define sha1macro(func, val)
Server config with asio transport and TLS disabled.
Definition: asio_no_tls.hpp:38
static const long timeout_socket_shutdown
Length of time to wait for socket shutdown.
Definition: core.hpp:137
static const long timeout_connect
Length of time to wait for TCP connect.
Definition: core.hpp:134
static const long timeout_dns_resolve
Length of time to wait for dns resolution.
Definition: core.hpp:131
static const long timeout_proxy
Length of time to wait before a proxy handshake is aborted.
Definition: core.hpp:121
static const long timeout_socket_pre_init
Default timer values (in ms)
Definition: core.hpp:118
static const long timeout_socket_post_init
Length of time to wait for socket post-initialization.
Definition: core.hpp:128
Server config with iostream transport.
Definition: core.hpp:68
websocketpp::random::none::int_generator< uint32_t > rng_type
RNG policies.
Definition: core.hpp:93
static const websocketpp::log::level elog_level
Default static error logging channels.
Definition: core.hpp:176
websocketpp::transport::iostream::endpoint< transport_config > transport_type
Transport Endpoint Component.
Definition: core.hpp:142
static const size_t max_http_body_size
Default maximum http body size.
Definition: core.hpp:252
static const long timeout_open_handshake
Default timer values (in ms)
Definition: core.hpp:152
static const size_t max_message_size
Default maximum message size.
Definition: core.hpp:240
static const bool drop_on_protocol_error
Drop connections immediately on protocol error.
Definition: core.hpp:213
static const long timeout_close_handshake
Length of time before a closing handshake is aborted.
Definition: core.hpp:154
static const websocketpp::log::level alog_level
Default static access logging channels.
Definition: core.hpp:189
websocketpp::log::basic< concurrency_type, websocketpp::log::elevel > elog_type
Logging policies.
Definition: core.hpp:88
static const long timeout_pong
Length of time to wait for a pong after a ping.
Definition: core.hpp:156
static const bool silent_close
Suppresses the return of detailed connection close information.
Definition: core.hpp:228
static bool const enable_multithreading
Definition: core.hpp:98
static const size_t connection_read_buffer_size
Size of the per-connection read buffer.
Definition: core.hpp:204
static const bool enable_extensions
Global flag for enabling/disabling extensions.
Definition: core.hpp:255
static const int client_version
WebSocket Protocol version to use as a client.
Definition: core.hpp:164
The constant size component of a WebSocket frame header.
Definition: frame.hpp:189
The variable size component of a WebSocket frame header.
Definition: frame.hpp:235
Package of log levels for logging access events.
Definition: levels.hpp:112
static char const * channel_name(level channel)
Get the textual name of a channel given a channel id.
Definition: levels.hpp:164
static level const fail
One line for each failed WebSocket connection with details.
Definition: levels.hpp:147
static level const none
Special aggregate value representing "no levels".
Definition: levels.hpp:114
static level const debug_handshake
Extra information about opening handshakes.
Definition: levels.hpp:137
static level const devel
Development messages (warning: very chatty)
Definition: levels.hpp:141
static level const all
Special aggregate value representing "all levels".
Definition: levels.hpp:152
static level const debug_close
Extra information about closing handshakes.
Definition: levels.hpp:139
static level const frame_payload
One line per frame, includes the full message payload (warning: chatty)
Definition: levels.hpp:129
static level const connect
Information about new connections.
Definition: levels.hpp:121
static level const app
Special channel for application specific logs. Not used by the library.
Definition: levels.hpp:143
static level const frame_header
One line per frame, includes the full frame header.
Definition: levels.hpp:127
static level const message_payload
Reserved.
Definition: levels.hpp:133
static level const endpoint
Reserved.
Definition: levels.hpp:135
static level const message_header
Reserved.
Definition: levels.hpp:131
static level const control
One line per control frame.
Definition: levels.hpp:125
static level const disconnect
One line for each closed connection. Includes closing codes and reasons.
Definition: levels.hpp:123
static level const access_core
Definition: levels.hpp:150
static level const http
Access related to HTTP requests.
Definition: levels.hpp:145
Package of values for hinting at the nature of a given logger.
Definition: levels.hpp:46
static value const none
No information.
Definition: levels.hpp:51
static value const access
Access log.
Definition: levels.hpp:53
static value const error
Error log.
Definition: levels.hpp:55
uint32_t value
Type of a channel type hint value.
Definition: levels.hpp:48
Package of log levels for logging errors.
Definition: levels.hpp:59
static level const devel
Low level debugging information (warning: very chatty)
Definition: levels.hpp:63
static char const * channel_name(level channel)
Get the textual name of a channel given a channel id.
Definition: levels.hpp:91
static level const library
Definition: levels.hpp:66
static level const info
Definition: levels.hpp:69
static level const all
Special aggregate value representing "all levels".
Definition: levels.hpp:80
static level const fatal
Definition: levels.hpp:78
static level const none
Special aggregate value representing "no levels".
Definition: levels.hpp:61
static level const rerror
Definition: levels.hpp:75
static level const warn
Definition: levels.hpp:72
A simple utility buffer class.
Definition: connection.hpp:138
Helper less than functor for case insensitive find.
Definition: utilities.hpp:75
Helper functor for case insensitive find.
Definition: utilities.hpp:49
bool operator()(charT ch1, charT ch2)
Perform a case insensitive comparison.
Definition: utilities.hpp:63
my_equal(std::locale const &loc)
Construct the functor with the given locale.
Definition: utilities.hpp:54
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_END_
#define _WEBSOCKETPP_ERROR_CODE_ENUM_NS_START_
Type used to convert close statuses between integer and wire representations.
Definition: close.hpp:275
Two byte conversion union.
Definition: frame.hpp:55
Four byte conversion union.
Definition: frame.hpp:61
Eight byte conversion union.
Definition: frame.hpp:67