ZMQ-based transport for knowledge. More...

#include <ZMQTransport.h>

Inheritance diagram for madara::transport::ZMQTransport:

Public Types
typedef std::vector< std::string >	HostsVector
	Used to define a vector of hosts to contact. More...

Public Member Functions
	ZMQTransport (const std::string &id, madara::knowledge::ThreadSafeContext &context, TransportSettings &config, bool launch_transport)
	Constructor. More...

virtual	~ZMQTransport ()
	Destructor. More...

int	check_transport (void)
	all subclasses should call this method at the beginning of send_data More...

virtual void	close (void) override
	Closes the transport. More...

void	invalidate_transport (void)
	Invalidates a transport to indicate it is shutting down. More...

long	prep_send (const knowledge::KnowledgeMap &orig_updates, const char *print_prefix)
	Preps a message for sending. More...

int	reliability (const int &setting)
	Sets the reliability setting. More...

int	reliability (void) const
	Accesses reliability setting. More...

long	send_data (const madara::knowledge::KnowledgeMap &updates) override
	Sends a list of knowledge updates to listeners. More...

TransportSettings &	settings (void)
	Getter for the transport settings. More...

virtual int	setup (void) override
	Initializes the transport. More...

int	validate_transport (void)
	Validates a transport to indicate it is not shutting down. More...

Protected Attributes
madara::utility::ScopedArray< char >	buffer_
	buffer for sending More...

madara::knowledge::ThreadSafeContext &	context_

HostsVector	hosts

const std::string	id_
	host:port identifier of this process More...

volatile bool	is_valid_

uint64_t	last_toi_sent_ = 0
	Latest TOI the previous send operation included. More...

madara::expression::ExpressionTree	on_data_received_
	data received rules, defined in Transport settings More...

PacketScheduler	packet_scheduler_
	scheduler for dropping packets to simulate network issues More...

BandwidthMonitor	receive_monitor_
	monitor for receiving bandwidth usage More...

BandwidthMonitor	send_monitor_
	monitor for sending bandwidth usage More...

QoSTransportSettings	settings_

volatile bool	shutting_down_

Private Attributes
knowledge::containers::Integer	failed_sends_
	failed sends More...

knowledge::KnowledgeBase	knowledge_
	knowledge base for threads to use More...

threads::Threader	read_threads_
	threads for reading knowledge updates More...

knowledge::containers::Integer	sent_data_
	sent data More...

knowledge::containers::Integer	sent_data_max_
	max data sent More...

knowledge::containers::Integer	sent_data_min_
	min data sent More...

knowledge::containers::Integer	sent_packets_
	sent packets More...

void *	write_socket_
	underlying socket for sending More...

Detailed Description

ZMQ-based transport for knowledge.

This transport currently supports the following transport settings:
1) a single host:port pairing
2) the reduced message header
3) the normal message header
4) domain differentiation
5) on data received logic
6) multi-assignment of records
7) rebroadcasting

Definition at line 43 of file ZMQTransport.h.

Member Typedef Documentation

◆ HostsVector

typedef std::vector<std::string> madara::transport::Base::HostsVector

inherited

Used to define a vector of hosts to contact.

Definition at line 51 of file Transport.h.

Constructor & Destructor Documentation

◆ ZMQTransport()

madara::transport::ZMQTransport::ZMQTransport	(	const std::string &	id,
		madara::knowledge::ThreadSafeContext &	context,
		TransportSettings &	config,
		bool	launch_transport
	)

Constructor.

Parameters

id	unique identifer - usually a combination of host:port
context	knowledge context
config	transport configuration settings
launch_transport	whether or not to launch this transport

Definition at line 16 of file ZMQTransport.cpp.

◆ ~ZMQTransport()

madara::transport::ZMQTransport::~ZMQTransport ( )

virtual

Destructor.

Definition at line 46 of file ZMQTransport.cpp.

Member Function Documentation

◆ check_transport()

int madara::transport::Base::check_transport ( void )

inlineinherited

all subclasses should call this method at the beginning of send_data

Definition at line 17 of file Transport.inl.

◆ close()

void madara::transport::ZMQTransport::close ( void )

overridevirtual

Closes the transport.

Reimplemented from madara::transport::Base.

Definition at line 54 of file ZMQTransport.cpp.

◆ invalidate_transport()

void madara::transport::Base::invalidate_transport ( void )

inlineinherited

Invalidates a transport to indicate it is shutting down.

Definition at line 31 of file Transport.inl.

◆ prep_send()

long madara::transport::Base::prep_send	(	const knowledge::KnowledgeMap &	orig_updates,
		const char *	print_prefix
	)

inherited

Preps a message for sending.

Parameters

orig_updates	updates before send filtering is applied
print_prefix	prefix to include before every log message, e.g., "MyTransport::svc"

Returns: -1 Transport is shutting down
-2 Transport is invalid
-3 Unable to allocate send buffer
0 No message to send > 0 size of buffered message

filter the updates according to the filters specified by the user in QoSTransportSettings (if applicable)

size = buffer[0] (unsigned 64 bit) transport id = buffer[8] (8 byte) domain = buffer[16] (32 byte domain name) originator = buffer[48] (64 byte originator host:port) type = buffer[112] (unsigned 32 bit type of message–usually MULTIASSIGN) updates = buffer[116] (unsigned 32 bit number of updates) quality = buffer[120] (unsigned 32 bit quality of message) clock = buffer[124] (unsigned 64 bit clock for this message) ttl = buffer[132] (the new knowledge starts here) knowledge = buffer[133] (the new knowledge starts here)

Definition at line 860 of file Transport.cpp.

◆ reliability() [1/2]

int madara::transport::ZMQTransport::reliability ( const int & setting )

Sets the reliability setting.

Returns: the changed setting

Definition at line 94 of file ZMQTransport.cpp.

◆ reliability() [2/2]

int madara::transport::ZMQTransport::reliability ( void ) const

Accesses reliability setting.

Returns: whether we are using reliable dissemination or not

Definition at line 89 of file ZMQTransport.cpp.

◆ send_data()

long madara::transport::ZMQTransport::send_data ( const madara::knowledge::KnowledgeMap & updates )

overridevirtual

Sends a list of knowledge updates to listeners.

Parameters

updates listing of all updates that must be sent

Returns: result of write operation or -1 if we are shutting down

Implements madara::transport::Base.

Definition at line 253 of file ZMQTransport.cpp.

◆ settings()

madara::transport::TransportSettings & madara::transport::Base::settings ( void )

inlineinherited

Getter for the transport settings.

Returns: the current transport settings

Definition at line 40 of file Transport.inl.

◆ setup()

int madara::transport::ZMQTransport::setup ( void )

overridevirtual

Initializes the transport.

Returns: 0 if success

Reimplemented from madara::transport::Base.

Definition at line 99 of file ZMQTransport.cpp.

◆ validate_transport()

int madara::transport::Base::validate_transport ( void )

inlineinherited

Validates a transport to indicate it is not shutting down.

Definition at line 6 of file Transport.inl.

Member Data Documentation

◆ buffer_

madara::utility::ScopedArray<char> madara::transport::Base::buffer_

protectedinherited

buffer for sending

Definition at line 153 of file Transport.h.

◆ context_

madara::knowledge::ThreadSafeContext& madara::transport::Base::context_

protectedinherited

Definition at line 135 of file Transport.h.

◆ failed_sends_

knowledge::containers::Integer madara::transport::ZMQTransport::failed_sends_

private

failed sends

Definition at line 107 of file ZMQTransport.h.

◆ hosts

HostsVector madara::transport::Base::hosts

protectedinherited

Definition at line 127 of file Transport.h.

◆ id_

const std::string madara::transport::Base::id_

protectedinherited

host:port identifier of this process

Definition at line 130 of file Transport.h.

◆ is_valid_

volatile bool madara::transport::Base::is_valid_

protectedinherited

Definition at line 125 of file Transport.h.

◆ knowledge_

knowledge::KnowledgeBase madara::transport::ZMQTransport::knowledge_

private

knowledge base for threads to use

Definition at line 95 of file ZMQTransport.h.

◆ last_toi_sent_

uint64_t madara::transport::Base::last_toi_sent_ = 0

protectedinherited

Latest TOI the previous send operation included.

Definition at line 156 of file Transport.h.

◆ on_data_received_

madara::expression::ExpressionTree madara::transport::Base::on_data_received_

protectedinherited

data received rules, defined in Transport settings

Definition at line 139 of file Transport.h.

◆ packet_scheduler_

PacketScheduler madara::transport::Base::packet_scheduler_

protectedinherited

scheduler for dropping packets to simulate network issues

Definition at line 150 of file Transport.h.

◆ read_threads_

threads::Threader madara::transport::ZMQTransport::read_threads_

private

threads for reading knowledge updates

Definition at line 98 of file ZMQTransport.h.

◆ receive_monitor_

BandwidthMonitor madara::transport::Base::receive_monitor_

protectedinherited

monitor for receiving bandwidth usage

Definition at line 147 of file Transport.h.

◆ send_monitor_

BandwidthMonitor madara::transport::Base::send_monitor_

protectedinherited

monitor for sending bandwidth usage

Definition at line 144 of file Transport.h.

◆ sent_data_

knowledge::containers::Integer madara::transport::ZMQTransport::sent_data_

private

sent data

Definition at line 110 of file ZMQTransport.h.

◆ sent_data_max_

knowledge::containers::Integer madara::transport::ZMQTransport::sent_data_max_

private

max data sent

Definition at line 113 of file ZMQTransport.h.

◆ sent_data_min_

knowledge::containers::Integer madara::transport::ZMQTransport::sent_data_min_

private

min data sent

Definition at line 116 of file ZMQTransport.h.

◆ sent_packets_

knowledge::containers::Integer madara::transport::ZMQTransport::sent_packets_

private

sent packets

Definition at line 104 of file ZMQTransport.h.

◆ settings_

QoSTransportSettings madara::transport::Base::settings_

protectedinherited

Definition at line 132 of file Transport.h.

◆ shutting_down_

volatile bool madara::transport::Base::shutting_down_

protectedinherited

Definition at line 126 of file Transport.h.

◆ write_socket_

void* madara::transport::ZMQTransport::write_socket_

private

underlying socket for sending

Definition at line 101 of file ZMQTransport.h.

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

include/madara/transport/zmq/ZMQTransport.h
include/madara/transport/zmq/ZMQTransport.cpp

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ HostsVector

Constructor & Destructor Documentation

◆ ZMQTransport()

◆ ~ZMQTransport()

Member Function Documentation

◆ check_transport()

◆ close()

◆ invalidate_transport()

◆ prep_send()

◆ reliability() [1/2]

◆ reliability() [2/2]

◆ send_data()

◆ settings()

◆ setup()

◆ validate_transport()

Member Data Documentation

◆ buffer_

◆ context_

◆ failed_sends_

◆ hosts

◆ id_

◆ is_valid_

◆ knowledge_

◆ last_toi_sent_

◆ on_data_received_

◆ packet_scheduler_

◆ read_threads_

◆ receive_monitor_

◆ send_monitor_

◆ sent_data_

◆ sent_data_max_

◆ sent_data_min_

◆ sent_packets_

◆ settings_

◆ shutting_down_

◆ write_socket_