zmq::zap_client_common_handshake_t Class Reference

#include <zap_client.hpp>

Inheritance diagram for zmq::zap_client_common_handshake_t:

Protected Types
enum	state_t {   waiting_for_hello, sending_welcome, waiting_for_initiate, waiting_for_zap_reply,   sending_ready, sending_error, error_sent, ready }

Protected Member Functions
void	handle_zap_status_code () ZMQ_FINAL
int	receive_and_process_zap_reply () ZMQ_FINAL
status_t	status () const ZMQ_FINAL
	zap_client_common_handshake_t (session_base_t *session_, const std::string &peer_address_, const options_t &options_, state_t zap_reply_ok_state_)
int	zap_msg_available () ZMQ_FINAL
Protected Member Functions inherited from zmq::mechanism_base_t
int	check_basic_command_structure (msg_t *msg_) const
void	handle_error_reason (const char *error_reason_, size_t error_reason_len_)
	mechanism_base_t (session_base_t *session_, const options_t &options_)
bool	zap_required () const
Protected Member Functions inherited from zmq::mechanism_t
size_t	add_basic_properties (unsigned char *ptr_, size_t ptr_capacity_) const
size_t	basic_properties_len () const
void	make_command_with_basic_properties (msg_t *msg_, const char *prefix_, size_t prefix_len_) const
int	parse_metadata (const unsigned char *ptr_, size_t length_, bool zap_flag_=false)
virtual int	property (const std::string &name_, const void *value_, size_t length_)

Protected Attributes
state_t	state
Protected Attributes inherited from zmq::zap_client_t
const std::string	peer_address
std::string	status_code
Protected Attributes inherited from zmq::mechanism_base_t
session_base_t *const	session
Protected Attributes inherited from zmq::mechanism_t
const options_t	options

Private Attributes
const state_t	_zap_reply_ok_state

Additional Inherited Members
Public Types inherited from zmq::mechanism_t
enum	status_t { handshaking, ready, error }
Public Member Functions inherited from zmq::zap_client_t
void	send_zap_request (const char *mechanism_, size_t mechanism_length_, const uint8_t **credentials_, size_t *credentials_sizes_, size_t credentials_count_)
void	send_zap_request (const char *mechanism_, size_t mechanism_length_, const uint8_t *credentials_, size_t credentials_size_)
	zap_client_t (session_base_t *session_, const std::string &peer_address_, const options_t &options_)
Public Member Functions inherited from zmq::mechanism_t
virtual int	decode (msg_t *)
virtual int	encode (msg_t *)
const blob_t &	get_user_id () const
const metadata_t::dict_t &	get_zap_properties () const
const metadata_t::dict_t &	get_zmtp_properties () const
	mechanism_t (const options_t &options_)
virtual int	next_handshake_command (msg_t *msg_)=0
void	peer_routing_id (msg_t *msg_)
virtual int	process_handshake_command (msg_t *msg_)=0
void	set_peer_routing_id (const void *id_ptr_, size_t id_size_)
void	set_user_id (const void *user_id_, size_t size_)
virtual	~mechanism_t ()
Static Protected Member Functions inherited from zmq::mechanism_t
static size_t	add_property (unsigned char *ptr_, size_t ptr_capacity_, const char *name_, const void *value_, size_t value_len_)
static size_t	property_len (const char *name_, size_t value_len_)
static const char *	socket_type_string (int socket_type_)

Detailed Description

Definition at line 38 of file zap_client.hpp.

Member Enumeration Documentation

state_t

enum zmq::zap_client_common_handshake_t::state_t

protected

Enumerator
waiting_for_hello
sending_welcome
waiting_for_initiate
waiting_for_zap_reply
sending_ready
sending_error
error_sent
ready

Definition at line 41 of file zap_client.hpp.

Constructor & Destructor Documentation

zap_client_common_handshake_t()

zmq::zap_client_common_handshake_t::zap_client_common_handshake_t ( session_base_t *  session_, const std::string &  peer_address_, const options_t &  options_, state_t  zap_reply_ok_state_  )

protected

Definition at line 231 of file zap_client.cpp.

Member Function Documentation

handle_zap_status_code()

void zmq::zap_client_common_handshake_t::handle_zap_status_code ( )

protectedvirtual

Reimplemented from zmq::zap_client_t.

Definition at line 259 of file zap_client.cpp.

receive_and_process_zap_reply()

int zmq::zap_client_common_handshake_t::receive_and_process_zap_reply ( )

protectedvirtual

Reimplemented from zmq::zap_client_t.

Definition at line 281 of file zap_client.cpp.

status()

zmq::mechanism_t::status_t zmq::zap_client_common_handshake_t::status ( ) const

protectedvirtual

Implements zmq::mechanism_t.

Definition at line 243 of file zap_client.cpp.

zap_msg_available()

int zmq::zap_client_common_handshake_t::zap_msg_available ( )

protectedvirtual

Reimplemented from zmq::mechanism_t.

Definition at line 253 of file zap_client.cpp.

Member Data Documentation

_zap_reply_ok_state

const state_t zmq::zap_client_common_handshake_t::_zap_reply_ok_state

private

Definition at line 70 of file zap_client.hpp.

state

state_t zmq::zap_client_common_handshake_t::state

protected

Definition at line 67 of file zap_client.hpp.

---

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

• zap_client.hpp
• zap_client.cpp