Public Member Functions | Protected Attributes | List of all members
zmq::zap_client_t Class Reference

#include <zap_client.hpp>

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

Public Member Functions

virtual void handle_zap_status_code ()
 
virtual int receive_and_process_zap_reply ()
 
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_tget_user_id () const
 
const metadata_t::dict_tget_zap_properties () const
 
const metadata_t::dict_tget_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 Attributes

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
 

Additional Inherited Members

- Public Types inherited from zmq::mechanism_t
enum  status_t { handshaking, ready, error }
 
- 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_)
 
- 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 10 of file zap_client.hpp.

Constructor & Destructor Documentation

◆ zap_client_t()

zmq::zap_client_t::zap_client_t ( session_base_t session_,
const std::string peer_address_,
const options_t options_ 
)

Definition at line 17 of file zap_client.cpp.

Member Function Documentation

◆ handle_zap_status_code()

void zmq::zap_client_t::handle_zap_status_code ( )
virtual

Reimplemented in zmq::zap_client_common_handshake_t.

Definition at line 208 of file zap_client.cpp.

◆ receive_and_process_zap_reply()

int zmq::zap_client_t::receive_and_process_zap_reply ( )
virtual

Reimplemented in zmq::zap_client_common_handshake_t.

Definition at line 114 of file zap_client.cpp.

◆ send_zap_request() [1/2]

void zmq::zap_client_t::send_zap_request ( const char *  mechanism_,
size_t  mechanism_length_,
const uint8_t **  credentials_,
size_t *  credentials_sizes_,
size_t  credentials_count_ 
)

Definition at line 33 of file zap_client.cpp.

◆ send_zap_request() [2/2]

void zmq::zap_client_t::send_zap_request ( const char *  mechanism_,
size_t  mechanism_length_,
const uint8_t *  credentials_,
size_t  credentials_size_ 
)

Definition at line 24 of file zap_client.cpp.

Member Data Documentation

◆ peer_address

const std::string zmq::zap_client_t::peer_address
protected

Definition at line 32 of file zap_client.hpp.

◆ status_code

std::string zmq::zap_client_t::status_code
protected

Definition at line 35 of file zap_client.hpp.


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


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