Public Types | Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
zmq::mechanism_t Class Referenceabstract

#include <mechanism.hpp>

Inheritance diagram for zmq::mechanism_t:
Inheritance graph
[legend]

Public Types

enum  status_t { handshaking, ready, error }
 

Public Member Functions

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 status_t status () const =0
 
virtual int zap_msg_available ()
 
virtual ~mechanism_t ()
 

Protected Member Functions

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_)
 

Static Protected Member Functions

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_)
 

Protected Attributes

const options_t options
 

Private Member Functions

bool check_socket_type (const char *type_, size_t len_) const
 

Private Attributes

blob_t _routing_id
 
blob_t _user_id
 
metadata_t::dict_t _zap_properties
 
metadata_t::dict_t _zmtp_properties
 

Detailed Description

Definition at line 19 of file mechanism.hpp.

Member Enumeration Documentation

◆ status_t

enum zmq::mechanism_t::status_t
Enumerator
handshaking 
ready 
error 

Definition at line 22 of file mechanism.hpp.

Constructor & Destructor Documentation

◆ mechanism_t()

zmq::mechanism_t::mechanism_t ( const options_t &  options_)

Definition at line 14 of file mechanism.cpp.

◆ ~mechanism_t()

zmq::mechanism_t::~mechanism_t ( )
virtual

Definition at line 18 of file mechanism.cpp.

Member Function Documentation

◆ add_basic_properties()

size_t zmq::mechanism_t::add_basic_properties ( unsigned char *  ptr_,
size_t  ptr_capacity_ 
) const
protected

Definition at line 141 of file mechanism.cpp.

◆ add_property()

size_t zmq::mechanism_t::add_property ( unsigned char *  ptr_,
size_t  ptr_capacity_,
const char *  name_,
const void *  value_,
size_t  value_len_ 
)
staticprotected

Definition at line 111 of file mechanism.cpp.

◆ basic_properties_len()

size_t zmq::mechanism_t::basic_properties_len ( ) const
protected

Definition at line 172 of file mechanism.cpp.

◆ check_socket_type()

bool zmq::mechanism_t::check_socket_type ( const char *  type_,
size_t  len_ 
) const
private

Definition at line 283 of file mechanism.cpp.

◆ decode()

virtual int zmq::mechanism_t::decode ( msg_t *  )
inlinevirtual

Definition at line 41 of file mechanism.hpp.

◆ encode()

virtual int zmq::mechanism_t::encode ( msg_t *  )
inlinevirtual

Definition at line 39 of file mechanism.hpp.

◆ get_user_id()

const zmq::blob_t & zmq::mechanism_t::get_user_id ( ) const

Definition at line 44 of file mechanism.cpp.

◆ get_zap_properties()

const metadata_t::dict_t& zmq::mechanism_t::get_zap_properties ( ) const
inline

Definition at line 62 of file mechanism.hpp.

◆ get_zmtp_properties()

const metadata_t::dict_t& zmq::mechanism_t::get_zmtp_properties ( ) const
inline

Definition at line 57 of file mechanism.hpp.

◆ make_command_with_basic_properties()

void zmq::mechanism_t::make_command_with_basic_properties ( msg_t *  msg_,
const char *  prefix_,
size_t  prefix_len_ 
) const
protected

Definition at line 193 of file mechanism.cpp.

◆ next_handshake_command()

virtual int zmq::mechanism_t::next_handshake_command ( msg_t *  msg_)
pure virtual

◆ parse_metadata()

int zmq::mechanism_t::parse_metadata ( const unsigned char *  ptr_,
size_t  length_,
bool  zap_flag_ = false 
)
protected

Definition at line 210 of file mechanism.cpp.

◆ peer_routing_id()

void zmq::mechanism_t::peer_routing_id ( msg_t *  msg_)

Definition at line 28 of file mechanism.cpp.

◆ process_handshake_command()

virtual int zmq::mechanism_t::process_handshake_command ( msg_t *  msg_)
pure virtual

◆ property()

int zmq::mechanism_t::property ( const std::string &  name_,
const void *  value_,
size_t  length_ 
)
protectedvirtual

Definition at line 265 of file mechanism.cpp.

◆ property_len()

size_t zmq::mechanism_t::property_len ( const char *  name_,
size_t  value_len_ 
)
staticprotected

Definition at line 133 of file mechanism.cpp.

◆ set_peer_routing_id()

void zmq::mechanism_t::set_peer_routing_id ( const void *  id_ptr_,
size_t  id_size_ 
)

Definition at line 22 of file mechanism.cpp.

◆ set_user_id()

void zmq::mechanism_t::set_user_id ( const void *  user_id_,
size_t  size_ 
)

Definition at line 36 of file mechanism.cpp.

◆ socket_type_string()

const char * zmq::mechanism_t::socket_type_string ( int  socket_type_)
staticprotected

Definition at line 73 of file mechanism.cpp.

◆ status()

virtual status_t zmq::mechanism_t::status ( ) const
pure virtual

Implemented in zmq::zap_client_common_handshake_t.

◆ zap_msg_available()

virtual int zmq::mechanism_t::zap_msg_available ( )
inlinevirtual

Reimplemented in zmq::zap_client_common_handshake_t.

Definition at line 44 of file mechanism.hpp.

Member Data Documentation

◆ _routing_id

blob_t zmq::mechanism_t::_routing_id
private

Definition at line 114 of file mechanism.hpp.

◆ _user_id

blob_t zmq::mechanism_t::_user_id
private

Definition at line 116 of file mechanism.hpp.

◆ _zap_properties

metadata_t::dict_t zmq::mechanism_t::_zap_properties
private

Definition at line 112 of file mechanism.hpp.

◆ _zmtp_properties

metadata_t::dict_t zmq::mechanism_t::_zmtp_properties
private

Definition at line 109 of file mechanism.hpp.

◆ options

const options_t zmq::mechanism_t::options
protected

Definition at line 105 of file mechanism.hpp.

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

libaditof
Author(s):
autogenerated on Wed May 21 2025 02:07:11