websocketpp
0.3.0
C++/Boost Asio based websocket client/server library
|
Processor for Hybi version 13 (RFC6455) More...
#include <hybi13.hpp>
Classes | |
struct | msg_metadata |
Public Types | |
typedef processor< config > | base |
typedef config::request_type | request_type |
typedef config::response_type | response_type |
typedef config::message_type | message_type |
typedef message_type::ptr | message_ptr |
typedef config::con_msg_manager_type | msg_manager_type |
typedef msg_manager_type::ptr | msg_manager_ptr |
typedef config::rng_type | rng_type |
typedef config::permessage_deflate_type | permessage_deflate_type |
typedef std::pair < lib::error_code, std::string > | err_str_pair |
![]() | |
typedef processor< config > | type |
typedef config::request_type | request_type |
typedef config::response_type | response_type |
typedef config::message_type::ptr | message_ptr |
typedef std::pair < lib::error_code, std::string > | err_str_pair |
Public Member Functions | |
hybi13 (bool secure, bool p_is_server, msg_manager_ptr manager, rng_type &rng) | |
int | get_version () const |
Get the protocol version of this processor. | |
bool | has_permessage_deflate () const |
err_str_pair | negotiate_extensions (request_type const &req) |
Initializes extensions based on the Sec-WebSocket-Extensions header. More... | |
lib::error_code | validate_handshake (request_type const &r) const |
validate a WebSocket handshake request for this version More... | |
lib::error_code | process_handshake (request_type const &request, const std::string &subprotocol, response_type &response) const |
Calculate the appropriate response for this websocket request. More... | |
lib::error_code | client_handshake_request (request_type &req, uri_ptr uri, std::vector< std::string > const &subprotocols) const |
Fill in an HTTP request for an outgoing connection handshake. More... | |
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. More... | |
std::string | get_raw (response_type const &res) const |
Given a completed response, get the raw bytes to put on the wire. | |
std::string const & | get_origin (request_type const &r) const |
Return the value of the header containing the CORS origin. | |
lib::error_code | extract_subprotocols (request_type const &req, std::vector< std::string > &subprotocol_list) |
Extracts requested subprotocols from a handshake request. More... | |
uri_ptr | get_uri (request_type const &request) const |
Extracts client uri from a handshake request. | |
size_t | consume (uint8_t *buf, size_t len, lib::error_code &ec) |
Process new websocket connection bytes. More... | |
void | reset_headers () |
bool | ready () const |
Test whether or not the processor has a message ready. | |
message_ptr | get_message () |
Retrieves the most recently processed message. More... | |
bool | get_error () const |
Test whether or not the processor is in a fatal error state. | |
size_t | get_bytes_needed () const |
virtual lib::error_code | prepare_data_frame (message_ptr in, message_ptr out) |
Prepare a user data message for writing. More... | |
lib::error_code | prepare_ping (std::string const &in, message_ptr out) const |
Get URI. | |
lib::error_code | prepare_pong (std::string const &in, message_ptr out) const |
virtual lib::error_code | prepare_close (close::status::value code, std::string const &reason, message_ptr out) const |
![]() | |
processor (bool secure, bool p_is_server) | |
size_t | get_max_message_size () const |
Get maximum message size. More... | |
void | set_max_message_size (size_t new_value) |
Set maximum message size. More... | |
virtual bool | has_permessage_compress () const |
Returns whether or not the permessage_compress extension is implemented. More... | |
virtual lib::error_code | prepare_data_frame (message_ptr in, message_ptr out)=0 |
Prepare a data message for writing. More... | |
virtual lib::error_code | prepare_ping (std::string const &in, message_ptr out) const =0 |
Prepare a ping frame. More... | |
virtual lib::error_code | prepare_pong (std::string const &in, message_ptr out) const =0 |
Prepare a pong frame. More... | |
virtual lib::error_code | prepare_close (close::status::value code, std::string const &reason, message_ptr out) const =0 |
Prepare a close frame. More... | |
Protected Types | |
enum | state { HEADER_BASIC = 0, HEADER_EXTENDED = 1, EXTENSION = 2, APPLICATION = 3, READY = 4, FATAL_ERROR = 5 } |
Protected Member Functions | |
lib::error_code | process_handshake_key (std::string &key) const |
Convert a client handshake key into a server response key in place. | |
size_t | copy_basic_header_bytes (uint8_t const *buf, size_t len) |
Reads bytes from buf into m_basic_header. | |
size_t | copy_extended_header_bytes (uint8_t const *buf, size_t len) |
Reads bytes from buf into m_extended_header. | |
size_t | process_payload_bytes (uint8_t *buf, size_t len, lib::error_code &ec) |
Reads bytes from buf into message payload. More... | |
lib::error_code | validate_incoming_basic_header (frame::basic_header const &h, bool is_server, bool new_msg) const |
Validate an incoming basic header. More... | |
lib::error_code | validate_incoming_extended_header (frame::basic_header h, frame::extended_header e) const |
Validate an incoming extended header. More... | |
void | masked_copy (std::string const &i, std::string &o, frame::masking_key_type key) const |
Copy and mask/unmask in one operation. More... | |
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. More... | |
Protected Attributes | |
frame::basic_header | m_basic_header |
msg_manager_ptr | m_msg_manager |
size_t | m_bytes_needed |
size_t | m_cursor |
msg_metadata | m_data_msg |
msg_metadata | m_control_msg |
msg_metadata * | m_current_msg |
frame::extended_header | m_extended_header |
rng_type & | m_rng |
state | m_state |
permessage_deflate_type | m_permessage_deflate |
![]() | |
bool const | m_secure |
bool const | m_server |
size_t | m_max_message_size |
Processor for Hybi version 13 (RFC6455)
Definition at line 53 of file hybi13.hpp.
|
inlinevirtual |
Fill in an HTTP request for an outgoing connection handshake.
req | The request to process. |
Implements websocketpp::processor::processor< config >.
Definition at line 185 of file hybi13.hpp.
|
inlinevirtual |
Process new websocket connection bytes.
Hybi 13 data streams represent a series of variable length frames. Each frame is made up of a series of fixed length fields. The lengths of later fields are contained in earlier fields. The first field length is fixed by the spec.
This processor represents a state machine that keeps track of what field is presently being read and how many more bytes are needed to complete it
Read two header bytes Extract full frame length. Read extra header bytes Validate frame header (including extension validate) Read extension data into extension message state object Read payload data into payload
buf | Input buffer |
len | Length of input buffer |
Implements websocketpp::processor::processor< config >.
Definition at line 315 of file hybi13.hpp.
|
inlinevirtual |
Extracts requested subprotocols from a handshake request.
Extracts a list of all subprotocols that the client has requested in the given opening handshake request.
req | The request to extract from |
subprotocol_list | A reference to a vector of strings to store the results in. |
Implements websocketpp::processor::processor< config >.
Definition at line 265 of file hybi13.hpp.
|
inlinevirtual |
Retrieves the number of bytes presently needed by the processor This value may be used as a hint to the transport layer as to how many bytes to wait for before running consume again.
Reimplemented from websocketpp::processor::processor< config >.
Definition at line 486 of file hybi13.hpp.
|
inlinevirtual |
Retrieves the most recently processed message.
Retrieves a shared pointer to the recently completed message if there is one. If ready() returns true then there is a message available. Retrieving the message with get_message will reset the state of ready. As such, each new message may be retrieved only once. Calling get_message when there is no message available will result in a null pointer being returned.
Implements websocketpp::processor::processor< config >.
Definition at line 463 of file hybi13.hpp.
|
inlineprotected |
Copy and mask/unmask in one operation.
Reads input from one string and writes unmasked output to another.
[in] | i | The input string. |
[out] | o | The output string. |
[in] | key | The masking key to use for masking/unmasking |
Definition at line 867 of file hybi13.hpp.
|
inlinevirtual |
Initializes extensions based on the Sec-WebSocket-Extensions header.
Reads the Sec-WebSocket-Extensions header and determines if any of the requested extensions are supported by this processor. If they are their settings data is initialized.
Reimplemented from websocketpp::processor::processor< config >.
Definition at line 87 of file hybi13.hpp.
|
inlineprotected |
Generic prepare control frame with opcode and payload.
Internal control frame building method. Handles validation, masking, etc
op | The control opcode to use |
payload | The payload to use |
out | The message buffer to store the prepared frame in |
Definition at line 891 of file hybi13.hpp.
|
inlinevirtual |
Prepare a user data message for writing.
Performs validation, masking, compression, etc. will return an error if there was an error, otherwise msg will be ready to be written
By default WebSocket++ performs block masking/unmasking in a manner that makes assumptions about the nature of the machine and STL library used. In particular the assumption is either a 32 or 64 bit word size and an STL with std::string::data returning a contiguous char array.
This method improves masking performance by 3-8x depending on the ratio of small to large messages and the availability of a 64 bit processor.
To disable this optimization (for use with alternative STL implementations or processors) define WEBSOCKETPP_STRICT_MASKING when compiling the library. This will force the library to perform masking in single byte chunks.
TODO: tests
in | An unprepared message to prepare |
out | A message to be overwritten with the prepared message |
Definition at line 514 of file hybi13.hpp.
|
inlinevirtual |
Calculate the appropriate response for this websocket request.
req | The request to process |
subprotocol | The subprotocol in use |
res | The response to store the processed response in |
Implements websocketpp::processor::processor< config >.
Definition at line 163 of file hybi13.hpp.
|
inlineprotected |
Reads bytes from buf into message payload.
This function performs unmasking and uncompression, validates the decoded bytes, and writes them to the appropriate message buffer.
This member function will use the input buffer as stratch space for its work. The raw input bytes will not be preserved. This applies only to the bytes actually needed. At most min(m_bytes_needed,len) will be processed.
buf | Input/working buffer |
len | Length of buf |
Definition at line 695 of file hybi13.hpp.
|
inlinevirtual |
validate a WebSocket handshake request for this version
request | The WebSocket handshake request to validate. is_websocket_handshake(request) must be true and get_websocket_version(request) must equal this->get_version(). |
Implements websocketpp::processor::processor< config >.
Definition at line 139 of file hybi13.hpp.
|
inlineprotected |
Validate an incoming basic header.
Validates an incoming hybi13 basic header.
h | The basic header to validate |
is_server | Whether or not the endpoint that received this frame is a server. |
new_msg | Whether or not this is the first frame of the message |
Definition at line 754 of file hybi13.hpp.
|
inlineprotected |
Validate an incoming extended header.
Validates an incoming hybi13 full header.
h | The basic header to validate |
e | The extended header to validate |
Definition at line 832 of file hybi13.hpp.
|
inlinevirtual |
Validate the server's response to an outgoing handshake request.
req | The original request sent |
res | The reponse to generate |
Implements websocketpp::processor::processor< config >.
Definition at line 222 of file hybi13.hpp.