zmq::wss_engine_t Class Reference

#include <wss_engine.hpp>

Inheritance diagram for zmq::wss_engine_t:

Public Member Functions
void	out_event ()
	wss_engine_t (fd_t fd_, const options_t &options_, const endpoint_uri_pair_t &endpoint_uri_pair_, ws_address_t &address_, bool client_, void *tls_server_cred_, const std::string &hostname_)
	~wss_engine_t ()
Public Member Functions inherited from zmq::ws_engine_t
	ws_engine_t (fd_t fd_, const options_t &options_, const endpoint_uri_pair_t &endpoint_uri_pair_, const ws_address_t &address_, bool client_)
	~ws_engine_t ()
Public Member Functions inherited from zmq::stream_engine_base_t
const endpoint_uri_pair_t &	get_endpoint () const ZMQ_FINAL
bool	has_handshake_stage () ZMQ_FINAL
void	in_event () ZMQ_FINAL
void	plug (zmq::io_thread_t *io_thread_, zmq::session_base_t *session_) ZMQ_FINAL
bool	restart_input () ZMQ_FINAL
void	restart_output () ZMQ_FINAL
	stream_engine_base_t (fd_t fd_, const options_t &options_, const endpoint_uri_pair_t &endpoint_uri_pair_, bool has_handshake_stage_)
void	terminate () ZMQ_FINAL
void	timer_event (int id_) ZMQ_FINAL
void	zap_msg_available () ZMQ_FINAL
	~stream_engine_base_t () ZMQ_OVERRIDE
Public Member Functions inherited from zmq::io_object_t
	io_object_t (zmq::io_thread_t *io_thread_=NULL)
void	plug (zmq::io_thread_t *io_thread_)
void	unplug ()
	~io_object_t () ZMQ_OVERRIDE
Public Member Functions inherited from zmq::i_poll_events
virtual	~i_poll_events () ZMQ_DEFAULT
Public Member Functions inherited from zmq::i_engine
virtual	~i_engine () ZMQ_DEFAULT

Protected Member Functions
bool	handshake ()
void	plug_internal ()
int	read (void *data, size_t size_)
int	write (const void *data_, size_t size_)
Protected Member Functions inherited from zmq::ws_engine_t
int	decode_and_push (msg_t *msg_)
int	process_command_message (msg_t *msg_)
int	produce_ping_message (msg_t *msg_)
int	produce_pong_message (msg_t *msg_)
void	start_ws_handshake ()
Protected Member Functions inherited from zmq::stream_engine_base_t
virtual void	error (error_reason_t reason_)
bool	init_properties (properties_t &properties_)
int	next_handshake_command (msg_t *msg_)
int	process_handshake_command (msg_t *msg_)
virtual int	process_heartbeat_message (msg_t *msg_)
int	pull_and_encode (msg_t *msg_)
int	pull_msg_from_session (msg_t *msg_)
int	push_msg_to_session (msg_t *msg_)
int	push_one_then_decode_and_push (msg_t *msg_)
void	reset_pollout ()
session_base_t *	session ()
void	set_handshake_timer ()
void	set_pollin ()
void	set_pollout ()
socket_base_t *	socket ()
Protected Member Functions inherited from zmq::io_object_t
handle_t	add_fd (fd_t fd_)
void	add_timer (int timeout_, int id_)
void	cancel_timer (int id_)
void	reset_pollin (handle_t handle_)
void	reset_pollout (handle_t handle_)
void	rm_fd (handle_t handle_)
void	set_pollin (handle_t handle_)
void	set_pollout (handle_t handle_)

Private Member Functions
bool	do_handshake ()

Private Attributes
bool	_established
gnutls_certificate_credentials_t	_tls_client_cred
gnutls_session_t	_tls_session

Additional Inherited Members
Public Types inherited from zmq::i_engine
enum	error_reason_t { protocol_error, connection_error, timeout_error }
Protected Types inherited from zmq::stream_engine_base_t
enum	{ handshake_timer_id = 0x40 }
enum	{ heartbeat_ivl_timer_id = 0x80, heartbeat_timeout_timer_id = 0x81, heartbeat_ttl_timer_id = 0x82 }
typedef metadata_t::dict_t	properties_t
Protected Types inherited from zmq::io_object_t
typedef poller_t::handle_t	handle_t
Protected Attributes inherited from zmq::stream_engine_base_t
i_decoder *	_decoder
i_encoder *	_encoder
const endpoint_uri_pair_t	_endpoint_uri_pair
bool	_has_handshake_timer
bool	_has_heartbeat_timer
bool	_has_timeout_timer
bool	_has_ttl_timer
unsigned char *	_inpos
bool	_input_stopped
size_t	_insize
mechanism_t *	_mechanism
metadata_t *	_metadata
int(stream_engine_base_t::*	_next_msg )(msg_t *msg_)
const options_t	_options
unsigned char *	_outpos
bool	_output_stopped
size_t	_outsize
const std::string	_peer_address
int(stream_engine_base_t::*	_process_msg )(msg_t *msg_)

Detailed Description

Definition at line 13 of file wss_engine.hpp.

Constructor & Destructor Documentation

wss_engine_t()

zmq::wss_engine_t::wss_engine_t	(	fd_t	fd_,
		const options_t &	options_,
		const endpoint_uri_pair_t &	endpoint_uri_pair_,
		ws_address_t &	address_,
		bool	client_,
		void *	tls_server_cred_,
		const std::string &	hostname_
	)

Definition at line 28 of file wss_engine.cpp.

~wss_engine_t()

zmq::wss_engine_t::~wss_engine_t

(

)

Definition at line 90 of file wss_engine.cpp.

Member Function Documentation

do_handshake()

bool zmq::wss_engine_t::do_handshake ( )

private

Definition at line 112 of file wss_engine.cpp.

handshake()

bool zmq::wss_engine_t::handshake ( )

protectedvirtual

Reimplemented from zmq::ws_engine_t.

Definition at line 139 of file wss_engine.cpp.

out_event()

void zmq::wss_engine_t::out_event ( )

virtual

Reimplemented from zmq::stream_engine_base_t.

Definition at line 104 of file wss_engine.cpp.

plug_internal()

void zmq::wss_engine_t::plug_internal ( )

protectedvirtual

Reimplemented from zmq::ws_engine_t.

Definition at line 98 of file wss_engine.cpp.

read()

int zmq::wss_engine_t::read ( void *  data, size_t  size_  )

protectedvirtual

Reimplemented from zmq::stream_engine_base_t.

Definition at line 150 of file wss_engine.cpp.

write()

int zmq::wss_engine_t::write ( const void *  data_, size_t  size_  )

protectedvirtual

Reimplemented from zmq::stream_engine_base_t.

Definition at line 184 of file wss_engine.cpp.

Member Data Documentation

_established

bool zmq::wss_engine_t::_established

private

Definition at line 36 of file wss_engine.hpp.

_tls_client_cred

gnutls_certificate_credentials_t zmq::wss_engine_t::_tls_client_cred

private

Definition at line 37 of file wss_engine.hpp.

_tls_session

gnutls_session_t zmq::wss_engine_t::_tls_session

private

Definition at line 38 of file wss_engine.hpp.

---

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

• wss_engine.hpp
• wss_engine.cpp