MADARA  3.1.8
madara::transport::ZMQTransport Class Reference

ZMQ-based transport for knowledge. More...

#include <ZMQTransport.h>

Inheritance diagram for madara::transport::ZMQTransport:
Collaboration 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...
 
void close (void)
 Closes the transport. More...
 
void invalidate_transport (void)
 Invalidates a transport to indicate it is shutting down. More...
 
long prep_send (const madara::knowledge::KnowledgeRecords &orig_updates, const char *print_prefix)
 Preps a message for sending. More...
 
int reliability (void) const
 Accesses reliability setting. More...
 
int reliability (const int &setting)
 Sets the reliability setting. More...
 
long send_data (const madara::knowledge::KnowledgeRecords &updates)
 Sends a list of knowledge updates to listeners. More...
 
TransportSettingssettings (void)
 Getter for the transport settings. More...
 
int setup (void)
 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::ThreadSafeContextcontext_
 
HostsVector hosts
 
const std::string id_
 host:port identifier of this process More...
 
volatile bool is_valid_
 
ACE_Thread_Mutex mutex_
 
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_
 
Condition valid_setup_
 

Private Attributes

knowledge::KnowledgeBase knowledge_
 knowledge base for threads to use More...
 
threads::Threader read_threads_
 threads for reading knowledge updates 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

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

Used to define a vector of hosts to contact.

Definition at line 68 of file Transport.h.

Constructor & Destructor Documentation

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

Constructor.

Parameters
idunique identifer - usually a combination of host:port
contextknowledge context
configtransport configuration settings
launch_transportwhether or not to launch this transport

Definition at line 16 of file ZMQTransport.cpp.

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

Destructor.

Definition at line 35 of file ZMQTransport.cpp.

Member Function Documentation

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

all subclasses should call this method at the beginning of send_data

Definition at line 19 of file Transport.inl.

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

Closes the transport.

Reimplemented from madara::transport::Base.

Definition at line 44 of file ZMQTransport.cpp.

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

Invalidates a transport to indicate it is shutting down.

Definition at line 34 of file Transport.inl.

long madara::transport::Base::prep_send ( const madara::knowledge::KnowledgeRecords orig_updates,
const char *  print_prefix 
)
inherited

Preps a message for sending.

Parameters
orig_updatesupdates before send filtering is applied
print_prefixprefix 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 815 of file Transport.cpp.

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

Accesses reliability setting.

Returns
whether we are using reliable dissemination or not

Definition at line 79 of file ZMQTransport.cpp.

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

Sets the reliability setting.

Returns
the changed setting

Definition at line 85 of file ZMQTransport.cpp.

long madara::transport::ZMQTransport::send_data ( const madara::knowledge::KnowledgeRecords updates)
virtual

Sends a list of knowledge updates to listeners.

Parameters
updateslisting 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 217 of file ZMQTransport.cpp.

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

Getter for the transport settings.

Returns
the current transport settings

Definition at line 45 of file Transport.inl.

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

Initializes the transport.

Returns
0 if success

Reimplemented from madara::transport::Base.

Definition at line 91 of file ZMQTransport.cpp.

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

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

buffer for sending

Definition at line 209 of file Transport.h.

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

Definition at line 191 of file Transport.h.

HostsVector madara::transport::Base::hosts
protectedinherited

Definition at line 181 of file Transport.h.

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

host:port identifier of this process

Definition at line 186 of file Transport.h.

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

Definition at line 179 of file Transport.h.

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

knowledge base for threads to use

Definition at line 95 of file ZMQTransport.h.

ACE_Thread_Mutex madara::transport::Base::mutex_
protectedinherited

Definition at line 182 of file Transport.h.

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

data received rules, defined in Transport settings

Definition at line 195 of file Transport.h.

PacketScheduler madara::transport::Base::packet_scheduler_
protectedinherited

scheduler for dropping packets to simulate network issues

Definition at line 206 of file Transport.h.

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

threads for reading knowledge updates

Definition at line 98 of file ZMQTransport.h.

BandwidthMonitor madara::transport::Base::receive_monitor_
protectedinherited

monitor for receiving bandwidth usage

Definition at line 203 of file Transport.h.

BandwidthMonitor madara::transport::Base::send_monitor_
protectedinherited

monitor for sending bandwidth usage

Definition at line 200 of file Transport.h.

QoSTransportSettings madara::transport::Base::settings_
protectedinherited

Definition at line 188 of file Transport.h.

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

Definition at line 180 of file Transport.h.

Condition madara::transport::Base::valid_setup_
protectedinherited

Definition at line 183 of file Transport.h.

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: