Processor for Hybi Draft version 07. More...

#include <hybi07.hpp>

Inheritance diagram for websocketpp::processor::hybi07< config >:

[legend]

Collaboration diagram for websocketpp::processor::hybi07< config >:

[legend]

Public Types
typedef config::request_type	request_type

typedef config::con_msg_manager_type::ptr	msg_manager_ptr

typedef config::rng_type	rng_type

Public Types inherited from websocketpp::processor::hybi08< config >
typedef hybi08< config >	type

typedef config::request_type	request_type

typedef config::con_msg_manager_type::ptr	msg_manager_ptr

typedef config::rng_type	rng_type

Public Types inherited from websocketpp::processor::hybi13< config >
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

Public Types inherited from websocketpp::processor::processor< config >
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
	hybi07 (bool secure, bool p_is_server, msg_manager_ptr manager, rng_type &rng)

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.

int	get_version () const
	Get the protocol version of this processor.

Public Member Functions inherited from websocketpp::processor::hybi08< config >
	hybi08 (bool secure, bool p_is_server, msg_manager_ptr manager, rng_type &rng)

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.

int	get_version () const
	Get the protocol version of this processor.

std::string const &	get_origin (request_type const &r) const
	Return the value of the header containing the CORS origin.

Public Member Functions inherited from websocketpp::processor::hybi13< config >
	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 &request)
	Initializes extensions based on the Sec-WebSocket-Extensions header.

err_str_pair	negotiate_extensions (response_type const &response)
	Initializes extensions based on the Sec-WebSocket-Extensions header.

template<typename header_type >
err_str_pair	negotiate_extensions_helper (header_type const &header)
	Extension negotiation helper function.

lib::error_code	validate_handshake (request_type const &r) const
	validate a WebSocket handshake request for this version

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.

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.

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.

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.

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.

lib::error_code	finalize_message ()
	Perform any finalization actions on an incoming message.

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.

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.

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

Public Member Functions inherited from websocketpp::processor::processor< config >
	processor (bool secure, bool p_is_server)

virtual	~processor ()

size_t	get_max_message_size () const
	Get maximum message size.

void	set_max_message_size (size_t new_value)
	Set maximum message size.

virtual bool	has_permessage_compress () const
	Returns whether or not the permessage_compress extension is implemented.

virtual lib::error_code	prepare_data_frame (message_ptr in, message_ptr out)=0
	Prepare a data message for writing.

virtual lib::error_code	prepare_ping (std::string const &in, message_ptr out) const =0
	Prepare a ping frame.

virtual lib::error_code	prepare_pong (std::string const &in, message_ptr out) const =0
	Prepare a pong frame.

virtual lib::error_code	prepare_close (close::status::value code, std::string const &reason, message_ptr out) const =0
	Prepare a close frame.

Additional Inherited Members
Protected Types inherited from websocketpp::processor::hybi13< config >
enum	state { HEADER_BASIC = 0 , HEADER_EXTENDED = 1 , EXTENSION = 2 , APPLICATION = 3 , READY = 4 , FATAL_ERROR = 5 }

Protected Member Functions inherited from websocketpp::processor::hybi13< config >
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.

lib::error_code	validate_incoming_basic_header (frame::basic_header const &h, bool is_server, bool new_msg) const
	Validate an incoming basic header.

lib::error_code	validate_incoming_extended_header (frame::basic_header h, frame::extended_header e) const
	Validate an incoming extended header.

void	masked_copy (std::string const &i, std::string &o, frame::masking_key_type key) const
	Copy and mask/unmask in one operation.

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.

Protected Attributes inherited from websocketpp::processor::hybi13< config >
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

Protected Attributes inherited from websocketpp::processor::processor< config >
bool const	m_secure

bool const	m_server

size_t	m_max_message_size

Detailed Description

template<typename config>
class websocketpp::processor::hybi07< config >

The primary difference between 07 and 08 is a version number.

Definition at line 44 of file hybi07.hpp.

Member Typedef Documentation

◆ msg_manager_ptr

template<typename config >

config::con_msg_manager_type::ptr websocketpp::processor::hybi07< config >::msg_manager_ptr

Definition at line 48 of file hybi07.hpp.

◆ request_type

template<typename config >

config::request_type websocketpp::processor::hybi07< config >::request_type

Definition at line 46 of file hybi07.hpp.

◆ rng_type

template<typename config >

config::rng_type websocketpp::processor::hybi07< config >::rng_type

Definition at line 49 of file hybi07.hpp.

Constructor & Destructor Documentation

◆ hybi07()

template<typename config >

websocketpp::processor::hybi07< config >::hybi07	(	bool	secure,
		bool	p_is_server,
		msg_manager_ptr	manager,
		rng_type &	rng )

inlineexplicit

Definition at line 51 of file hybi07.hpp.

52 : hybi08<config>(secure, p_is_server, manager, rng) {}

websocketpp::processor::hybi08::hybi08

hybi08(bool secure, bool p_is_server, msg_manager_ptr manager, rng_type &rng)

Definition hybi08.hpp:52

Member Function Documentation

◆ client_handshake_request()

template<typename config >

lib::error_code websocketpp::processor::hybi07< config >::client_handshake_request	(	request_type &	,
		uri_ptr	,
		std::vector< std::string > const &	) const

inlinevirtual

The Hybi 07 processor only implements incoming connections so this will always return an error.

Parameters

[out]	req	Set of headers to fill in
[in]	uri	The uri being connected to
[in]	subprotocols	The list of subprotocols to request

Implements websocketpp::processor::processor< config >.

Definition at line 63 of file hybi07.hpp.

    {
        return error::make_error_code(error::no_protocol_support);
    }

Here is the call graph for this function:

◆ get_version()

template<typename config >

int websocketpp::processor::hybi07< config >::get_version ( ) const

inlinevirtual

Implements websocketpp::processor::processor< config >.

Definition at line 69 of file hybi07.hpp.

                            {
        return 7;
    }

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

libraries/fc/vendor/websocketpp/websocketpp/processors/hybi07.hpp

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ msg_manager_ptr

◆ request_type

◆ rng_type

Constructor & Destructor Documentation

◆ hybi07()

Member Function Documentation

◆ client_handshake_request()

◆ get_version()