zmq::options_t Struct Reference

#include <options.hpp>

Collaboration diagram for zmq::options_t:

Public Types
typedef std::vector< tcp_address_mask_t >	tcp_accept_filters_t

Public Member Functions
	options_t ()
int	getsockopt (int option_, void *optval_, size_t *optvallen_) const
bool	is_valid (int option_) const
int	setsockopt (int option_, const void *optval_, size_t optvallen_)

Public Attributes
uint64_t	affinity
int	as_server
int	backlog
bool	conflate
int	connect_timeout
bool	connected
uint8_t	curve_public_key [CURVE_KEYSIZE]
uint8_t	curve_secret_key [CURVE_KEYSIZE]
uint8_t	curve_server_key [CURVE_KEYSIZE]
bool	filter
bool	gss_plaintext
std::string	gss_principal
std::string	gss_service_principal
int	handshake_ivl
int	heartbeat_interval
int	heartbeat_timeout
uint16_t	heartbeat_ttl
unsigned char	identity [256]
unsigned char	identity_size
int	immediate
bool	invert_matching
bool	ipv6
int	linger
int64_t	maxmsgsize
int	mechanism
int	multicast_hops
int	multicast_maxtpdu
std::string	plain_password
std::string	plain_username
int	rate
bool	raw_notify
bool	raw_socket
int	rcvbuf
int	rcvhwm
int	rcvtimeo
int	reconnect_ivl
int	reconnect_ivl_max
int	recovery_ivl
bool	recv_identity
int	sndbuf
int	sndhwm
int	sndtimeo
int	socket_id
std::string	socks_proxy_address
tcp_accept_filters_t	tcp_accept_filters
int	tcp_keepalive
int	tcp_keepalive_cnt
int	tcp_keepalive_idle
int	tcp_keepalive_intvl
int	tcp_maxrt
int	tos
int	type
int	use_fd
std::string	zap_domain

Detailed Description

Definition at line 56 of file options.hpp.

Member Typedef Documentation

typedef std::vector<tcp_address_mask_t> zmq::options_t::tcp_accept_filters_t

Definition at line 163 of file options.hpp.

Constructor & Destructor Documentation

zmq::options_t::options_t

(

)

Definition at line 37 of file options.cpp.

References CURVE_KEYSIZE, curve_public_key, curve_secret_key, and curve_server_key.

Member Function Documentation

int zmq::options_t::getsockopt	(	int	option_,
		void *	optval_,
		size_t *	optvallen_
	)		const

Definition at line 642 of file options.cpp.

References affinity, as_server, backlog, conflate, connect_timeout, CURVE_KEYSIZE, CURVE_KEYSIZE_Z85, curve_public_key, curve_secret_key, curve_server_key, gss_plaintext, gss_principal, gss_service_principal, handshake_ivl, heartbeat_interval, heartbeat_timeout, heartbeat_ttl, identity, identity_size, immediate, invert_matching, ipv6, linger, maxmsgsize, mechanism, multicast_hops, multicast_maxtpdu, plain_password, plain_username, rate, rcvbuf, rcvhwm, rcvtimeo, reconnect_ivl, reconnect_ivl_max, recovery_ivl, sndbuf, sndhwm, sndtimeo, socks_proxy_address, tcp_keepalive, tcp_keepalive_cnt, tcp_keepalive_idle, tcp_keepalive_intvl, tcp_maxrt, tos, type, use_fd, zap_domain, ZMQ_AFFINITY, zmq_assert, ZMQ_BACKLOG, ZMQ_CONFLATE, ZMQ_CONNECT_TIMEOUT, ZMQ_CURVE, ZMQ_CURVE_PUBLICKEY, ZMQ_CURVE_SECRETKEY, ZMQ_CURVE_SERVER, ZMQ_CURVE_SERVERKEY, ZMQ_GSSAPI, ZMQ_GSSAPI_PLAINTEXT, ZMQ_GSSAPI_PRINCIPAL, ZMQ_GSSAPI_SERVER, ZMQ_GSSAPI_SERVICE_PRINCIPAL, ZMQ_HANDSHAKE_IVL, ZMQ_HEARTBEAT_IVL, ZMQ_HEARTBEAT_TIMEOUT, ZMQ_HEARTBEAT_TTL, ZMQ_IDENTITY, ZMQ_IMMEDIATE, ZMQ_INVERT_MATCHING, ZMQ_IPV4ONLY, ZMQ_IPV6, ZMQ_LINGER, ZMQ_MAXMSGSIZE, ZMQ_MECHANISM, ZMQ_MULTICAST_HOPS, ZMQ_MULTICAST_MAXTPDU, ZMQ_PLAIN, ZMQ_PLAIN_PASSWORD, ZMQ_PLAIN_SERVER, ZMQ_PLAIN_USERNAME, ZMQ_RATE, ZMQ_RCVBUF, ZMQ_RCVHWM, ZMQ_RCVTIMEO, ZMQ_RECONNECT_IVL, ZMQ_RECONNECT_IVL_MAX, ZMQ_RECOVERY_IVL, ZMQ_SNDBUF, ZMQ_SNDHWM, ZMQ_SNDTIMEO, ZMQ_SOCKS_PROXY, ZMQ_TCP_KEEPALIVE, ZMQ_TCP_KEEPALIVE_CNT, ZMQ_TCP_KEEPALIVE_IDLE, ZMQ_TCP_KEEPALIVE_INTVL, ZMQ_TCP_MAXRT, ZMQ_TOS, ZMQ_TYPE, ZMQ_USE_FD, zmq_z85_encode(), and ZMQ_ZAP_DOMAIN.

Referenced by zmq::socket_base_t::getsockopt().

Here is the call graph for this function:

Here is the caller graph for this function:

bool zmq::options_t::is_valid

(

int

option_

)

const

Definition at line 1038 of file options.cpp.

References LIBZMQ_UNUSED.

Referenced by zmq::socket_base_t::setsockopt().

Here is the caller graph for this function:

int zmq::options_t::setsockopt	(	int	option_,
		const void *	optval_,
		size_t	optvallen_
	)

Definition at line 93 of file options.cpp.

References affinity, as_server, backlog, conflate, connect_timeout, CURVE_KEYSIZE, CURVE_KEYSIZE_Z85, curve_public_key, curve_secret_key, curve_server_key, gss_plaintext, gss_principal, gss_service_principal, handshake_ivl, heartbeat_interval, heartbeat_timeout, heartbeat_ttl, identity, identity_size, immediate, invert_matching, ipv6, linger, maxmsgsize, mechanism, multicast_hops, multicast_maxtpdu, plain_password, plain_username, rate, rcvbuf, rcvhwm, rcvtimeo, reconnect_ivl, reconnect_ivl_max, recovery_ivl, zmq::tcp_address_mask_t::resolve(), sndbuf, sndhwm, sndtimeo, socks_proxy_address, tcp_accept_filters, tcp_keepalive, tcp_keepalive_cnt, tcp_keepalive_idle, tcp_keepalive_intvl, tcp_maxrt, tos, use_fd, zap_domain, ZMQ_AFFINITY, zmq_assert, ZMQ_BACKLOG, ZMQ_CONFLATE, ZMQ_CONNECT_TIMEOUT, ZMQ_CURVE, ZMQ_CURVE_PUBLICKEY, ZMQ_CURVE_SECRETKEY, ZMQ_CURVE_SERVER, ZMQ_CURVE_SERVERKEY, ZMQ_GSSAPI, ZMQ_GSSAPI_PLAINTEXT, ZMQ_GSSAPI_PRINCIPAL, ZMQ_GSSAPI_SERVER, ZMQ_GSSAPI_SERVICE_PRINCIPAL, ZMQ_HANDSHAKE_IVL, ZMQ_HEARTBEAT_IVL, ZMQ_HEARTBEAT_TIMEOUT, ZMQ_HEARTBEAT_TTL, ZMQ_IDENTITY, ZMQ_IMMEDIATE, ZMQ_INVERT_MATCHING, ZMQ_IPC_FILTER_GID, ZMQ_IPC_FILTER_PID, ZMQ_IPC_FILTER_UID, ZMQ_IPV4ONLY, ZMQ_IPV6, ZMQ_LINGER, ZMQ_MAXMSGSIZE, ZMQ_MULTICAST_HOPS, ZMQ_MULTICAST_MAXTPDU, ZMQ_NULL, ZMQ_PLAIN, ZMQ_PLAIN_PASSWORD, ZMQ_PLAIN_SERVER, ZMQ_PLAIN_USERNAME, ZMQ_RATE, ZMQ_RCVBUF, ZMQ_RCVHWM, ZMQ_RCVTIMEO, ZMQ_RECONNECT_IVL, ZMQ_RECONNECT_IVL_MAX, ZMQ_RECOVERY_IVL, ZMQ_SNDBUF, ZMQ_SNDHWM, ZMQ_SNDTIMEO, ZMQ_SOCKS_PROXY, ZMQ_TCP_ACCEPT_FILTER, ZMQ_TCP_KEEPALIVE, ZMQ_TCP_KEEPALIVE_CNT, ZMQ_TCP_KEEPALIVE_IDLE, ZMQ_TCP_KEEPALIVE_INTVL, ZMQ_TCP_MAXRT, ZMQ_TOS, ZMQ_USE_FD, ZMQ_VMCI_BUFFER_MAX_SIZE, ZMQ_VMCI_BUFFER_MIN_SIZE, ZMQ_VMCI_BUFFER_SIZE, ZMQ_VMCI_CONNECT_TIMEOUT, zmq_z85_decode(), and ZMQ_ZAP_DOMAIN.

Referenced by zmq::socket_base_t::setsockopt().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

uint64_t zmq::options_t::affinity

Definition at line 70 of file options.hpp.

Referenced by zmq::socket_base_t::bind(), zmq::socket_base_t::connect(), getsockopt(), zmq::tcp_listener_t::in_event(), zmq::ipc_listener_t::in_event(), setsockopt(), and zmq::session_base_t::start_connecting().

int zmq::options_t::as_server

Definition at line 183 of file options.hpp.

Referenced by getsockopt(), zmq::stream_engine_t::handshake(), and setsockopt().

int zmq::options_t::backlog

Definition at line 121 of file options.hpp.

Referenced by getsockopt(), zmq::tcp_listener_t::set_address(), zmq::ipc_listener_t::set_address(), and setsockopt().

bool zmq::options_t::conflate

Definition at line 211 of file options.hpp.

Referenced by zmq::socket_base_t::connect(), zmq::ctx_t::connect_inproc_sockets(), getsockopt(), zmq::session_base_t::process_attach(), and setsockopt().

int zmq::options_t::connect_timeout

Definition at line 105 of file options.hpp.

Referenced by zmq::tcp_connecter_t::add_connect_timer(), getsockopt(), and setsockopt().

bool zmq::options_t::connected

Definition at line 217 of file options.hpp.

Referenced by zmq::socket_base_t::bind(), and zmq::socket_base_t::connect().

uint8_t zmq::options_t::curve_public_key[CURVE_KEYSIZE]

Definition at line 193 of file options.hpp.

Referenced by getsockopt(), options_t(), and setsockopt().

uint8_t zmq::options_t::curve_secret_key[CURVE_KEYSIZE]

Definition at line 194 of file options.hpp.

Referenced by getsockopt(), options_t(), and setsockopt().

uint8_t zmq::options_t::curve_server_key[CURVE_KEYSIZE]

Definition at line 195 of file options.hpp.

Referenced by getsockopt(), options_t(), and setsockopt().

bool zmq::options_t::filter

Definition at line 138 of file options.hpp.

Referenced by zmq::sub_t::sub_t(), zmq::xsub_t::xhas_in(), and zmq::xsub_t::xrecv().

bool zmq::options_t::gss_plaintext

Definition at line 202 of file options.hpp.

Referenced by getsockopt(), and setsockopt().

std::string zmq::options_t::gss_principal

Definition at line 198 of file options.hpp.

Referenced by getsockopt(), and setsockopt().

std::string zmq::options_t::gss_service_principal

Definition at line 199 of file options.hpp.

Referenced by getsockopt(), and setsockopt().

int zmq::options_t::handshake_ivl

Definition at line 215 of file options.hpp.

Referenced by getsockopt(), zmq::stream_engine_t::set_handshake_timer(), and setsockopt().

int zmq::options_t::heartbeat_interval

Definition at line 223 of file options.hpp.

Referenced by getsockopt(), zmq::stream_engine_t::mechanism_ready(), setsockopt(), zmq::stream_engine_t::stream_engine_t(), and zmq::stream_engine_t::timer_event().

int zmq::options_t::heartbeat_timeout

Definition at line 225 of file options.hpp.

Referenced by getsockopt(), setsockopt(), and zmq::stream_engine_t::stream_engine_t().

uint16_t zmq::options_t::heartbeat_ttl

Definition at line 221 of file options.hpp.

Referenced by getsockopt(), zmq::stream_engine_t::produce_ping_message(), and setsockopt().

unsigned char zmq::options_t::identity[256]

Definition at line 74 of file options.hpp.

Referenced by zmq::socket_base_t::connect(), zmq::ctx_t::connect_inproc_sockets(), getsockopt(), zmq::stream_engine_t::handshake(), zmq::stream_t::identify_peer(), zmq::stream_engine_t::identity_msg(), zmq::null_mechanism_t::next_handshake_command(), zmq::plain_client_t::produce_initiate(), zmq::plain_server_t::produce_ready(), zmq::null_mechanism_t::send_zap_request(), zmq::plain_server_t::send_zap_request(), and setsockopt().

unsigned char zmq::options_t::identity_size

Definition at line 73 of file options.hpp.

Referenced by zmq::socket_base_t::connect(), zmq::ctx_t::connect_inproc_sockets(), getsockopt(), zmq::stream_engine_t::handshake(), zmq::stream_t::identify_peer(), zmq::stream_engine_t::identity_msg(), zmq::null_mechanism_t::next_handshake_command(), zmq::stream_engine_t::plug(), zmq::plain_client_t::produce_initiate(), zmq::plain_server_t::produce_ready(), zmq::null_mechanism_t::send_zap_request(), zmq::plain_server_t::send_zap_request(), and setsockopt().

int zmq::options_t::immediate

Definition at line 135 of file options.hpp.

Referenced by zmq::socket_base_t::connect(), getsockopt(), zmq::socket_base_t::hiccuped(), zmq::session_base_t::reconnect(), and setsockopt().

bool zmq::options_t::invert_matching

Definition at line 143 of file options.hpp.

Referenced by getsockopt(), zmq::xsub_t::match(), setsockopt(), and zmq::xpub_t::xsend().

bool zmq::options_t::ipv6

Definition at line 131 of file options.hpp.

Referenced by zmq::socks_connecter_t::connect_to_proxy(), getsockopt(), zmq::tcp_connecter_t::open(), zmq::tcp_listener_t::set_address(), setsockopt(), zmq::socket_base_t::socket_base_t(), and zmq::socket_base_t::term_endpoint().

int zmq::options_t::linger

Definition at line 100 of file options.hpp.

Referenced by zmq::dish_t::dish_t(), getsockopt(), zmq::own_t::process_term_req(), setsockopt(), zmq::socket_base_t::socket_base_t(), zmq::own_t::terminate(), and zmq::xsub_t::xsub_t().

int64_t zmq::options_t::maxmsgsize

Definition at line 124 of file options.hpp.

Referenced by getsockopt(), zmq::stream_engine_t::handshake(), and setsockopt().

int zmq::options_t::mechanism

Definition at line 180 of file options.hpp.

Referenced by getsockopt(), zmq::stream_engine_t::handshake(), setsockopt(), and zmq::session_base_t::zap_enabled().

int zmq::options_t::multicast_hops

Definition at line 83 of file options.hpp.

Referenced by getsockopt(), and setsockopt().

int zmq::options_t::multicast_maxtpdu

Definition at line 87 of file options.hpp.

Referenced by getsockopt(), and setsockopt().

std::string zmq::options_t::plain_password

Definition at line 190 of file options.hpp.

Referenced by getsockopt(), zmq::plain_client_t::produce_hello(), and setsockopt().

std::string zmq::options_t::plain_username

Definition at line 189 of file options.hpp.

Referenced by getsockopt(), zmq::plain_client_t::produce_hello(), and setsockopt().

int zmq::options_t::rate

Definition at line 77 of file options.hpp.

Referenced by getsockopt(), and setsockopt().

bool zmq::options_t::raw_notify

Definition at line 150 of file options.hpp.

Referenced by zmq::stream_engine_t::error(), zmq::stream_engine_t::plug(), and zmq::stream_t::xsetsockopt().

bool zmq::options_t::raw_socket

Definition at line 149 of file options.hpp.

Referenced by zmq::stream_engine_t::error(), zmq::router_t::identify_peer(), zmq::session_base_t::pipe_terminated(), zmq::stream_engine_t::plug(), zmq::router_t::router_t(), zmq::stream_engine_t::set_handshake_timer(), zmq::stream_t::stream_t(), zmq::router_t::xsend(), and zmq::router_t::xsetsockopt().

int zmq::options_t::rcvbuf

Definition at line 91 of file options.hpp.

Referenced by zmq::socks_connecter_t::connect_to_proxy(), getsockopt(), zmq::tcp_connecter_t::open(), zmq::tcp_listener_t::set_address(), and setsockopt().

int zmq::options_t::rcvhwm

Definition at line 67 of file options.hpp.

Referenced by zmq::socket_base_t::connect(), zmq::ctx_t::connect_inproc_sockets(), getsockopt(), zmq::session_base_t::process_attach(), setsockopt(), and zmq::socket_base_t::update_pipe_options().

int zmq::options_t::rcvtimeo

Definition at line 127 of file options.hpp.

Referenced by getsockopt(), zmq::socket_base_t::recv(), and setsockopt().

int zmq::options_t::reconnect_ivl

Definition at line 114 of file options.hpp.

Referenced by zmq::ipc_connecter_t::get_new_reconnect_ivl(), zmq::tcp_connecter_t::get_new_reconnect_ivl(), zmq::socks_connecter_t::get_new_reconnect_ivl(), getsockopt(), zmq::session_base_t::reconnect(), and setsockopt().

int zmq::options_t::reconnect_ivl_max

Definition at line 118 of file options.hpp.

Referenced by zmq::ipc_connecter_t::get_new_reconnect_ivl(), zmq::tcp_connecter_t::get_new_reconnect_ivl(), zmq::socks_connecter_t::get_new_reconnect_ivl(), getsockopt(), and setsockopt().

int zmq::options_t::recovery_ivl

Definition at line 80 of file options.hpp.

Referenced by getsockopt(), and setsockopt().

bool zmq::options_t::recv_identity

Definition at line 146 of file options.hpp.

Referenced by zmq::socket_base_t::connect(), zmq::ctx_t::connect_inproc_sockets(), zmq::socket_base_t::extract_flags(), zmq::stream_engine_t::mechanism_ready(), zmq::mechanism_t::parse_metadata(), zmq::stream_engine_t::process_identity_msg(), zmq::router_t::router_t(), zmq::router_t::xsetsockopt(), and zmq::session_base_t::zap_connect().

int zmq::options_t::sndbuf

Definition at line 90 of file options.hpp.

Referenced by zmq::socks_connecter_t::connect_to_proxy(), getsockopt(), zmq::tcp_connecter_t::open(), zmq::tcp_listener_t::set_address(), and setsockopt().

int zmq::options_t::sndhwm

Definition at line 66 of file options.hpp.

Referenced by zmq::socket_base_t::connect(), zmq::ctx_t::connect_inproc_sockets(), getsockopt(), zmq::session_base_t::process_attach(), setsockopt(), and zmq::socket_base_t::update_pipe_options().

int zmq::options_t::sndtimeo

Definition at line 128 of file options.hpp.

Referenced by getsockopt(), zmq::socket_base_t::send(), and setsockopt().

int zmq::options_t::socket_id

Definition at line 205 of file options.hpp.

Referenced by zmq::socket_base_t::socket_base_t().

std::string zmq::options_t::socks_proxy_address

Definition at line 153 of file options.hpp.

Referenced by getsockopt(), setsockopt(), and zmq::session_base_t::start_connecting().

tcp_accept_filters_t zmq::options_t::tcp_accept_filters

Definition at line 164 of file options.hpp.

Referenced by zmq::tcp_listener_t::accept(), and setsockopt().

int zmq::options_t::tcp_keepalive

Definition at line 157 of file options.hpp.

Referenced by zmq::socks_connecter_t::check_proxy_connection(), getsockopt(), zmq::tcp_listener_t::in_event(), zmq::tcp_connecter_t::out_event(), and setsockopt().

int zmq::options_t::tcp_keepalive_cnt

Definition at line 158 of file options.hpp.

Referenced by zmq::socks_connecter_t::check_proxy_connection(), getsockopt(), zmq::tcp_listener_t::in_event(), zmq::tcp_connecter_t::out_event(), and setsockopt().

int zmq::options_t::tcp_keepalive_idle

Definition at line 159 of file options.hpp.

Referenced by zmq::socks_connecter_t::check_proxy_connection(), getsockopt(), zmq::tcp_listener_t::in_event(), zmq::tcp_connecter_t::out_event(), and setsockopt().

int zmq::options_t::tcp_keepalive_intvl

Definition at line 160 of file options.hpp.

Referenced by zmq::socks_connecter_t::check_proxy_connection(), getsockopt(), zmq::tcp_listener_t::in_event(), zmq::tcp_connecter_t::out_event(), and setsockopt().

int zmq::options_t::tcp_maxrt

Definition at line 110 of file options.hpp.

Referenced by getsockopt(), zmq::tcp_listener_t::in_event(), zmq::tcp_connecter_t::out_event(), and setsockopt().

int zmq::options_t::tos

Definition at line 94 of file options.hpp.

Referenced by zmq::tcp_listener_t::accept(), zmq::socks_connecter_t::connect_to_proxy(), getsockopt(), zmq::tcp_connecter_t::open(), zmq::tcp_listener_t::set_address(), and setsockopt().

int zmq::options_t::type

Definition at line 97 of file options.hpp.

Referenced by zmq::socket_base_t::check_protocol(), zmq::mechanism_t::check_socket_type(), zmq::client_t::client_t(), zmq::socket_base_t::connect(), zmq::ctx_t::connect_inproc_sockets(), zmq::session_base_t::create(), zmq::dealer_t::dealer_t(), zmq::dish_t::dish_t(), zmq::gather_t::gather_t(), getsockopt(), zmq::stream_engine_t::handshake(), zmq::null_mechanism_t::next_handshake_command(), zmq::pair_t::pair_t(), zmq::session_base_t::process_attach(), zmq::plain_client_t::produce_initiate(), zmq::plain_server_t::produce_ready(), zmq::pub_t::pub_t(), zmq::pull_t::pull_t(), zmq::push_t::push_t(), zmq::radio_t::radio_t(), zmq::session_base_t::reconnect(), zmq::rep_t::rep_t(), zmq::req_t::req_t(), zmq::router_t::router_t(), zmq::scatter_t::scatter_t(), zmq::server_t::server_t(), zmq::session_base_t::start_connecting(), zmq::stream_t::stream_t(), zmq::sub_t::sub_t(), zmq::xpub_t::xpub_t(), zmq::xpub_t::xread_activated(), zmq::xsub_t::xsub_t(), and zmq::session_base_t::zap_connect().

int zmq::options_t::use_fd

Definition at line 237 of file options.hpp.

Referenced by zmq::ipc_listener_t::close(), getsockopt(), zmq::tcp_listener_t::set_address(), zmq::ipc_listener_t::set_address(), and setsockopt().

std::string zmq::options_t::zap_domain

Definition at line 186 of file options.hpp.

Referenced by getsockopt(), zmq::null_mechanism_t::null_mechanism_t(), zmq::null_mechanism_t::send_zap_request(), zmq::plain_server_t::send_zap_request(), setsockopt(), and zmq::session_base_t::zap_enabled().