Base class to hold configuration settings for TransportImpls. More...

#include <TransportInst.h>

Inheritance diagram for OpenDDS::DCPS::TransportInst:

[legend]

Collaboration diagram for OpenDDS::DCPS::TransportInst:

[legend]

Public Member Functions
const OPENDDS_STRING &	name () const

virtual int	load (ACE_Configuration_Heap &cf, ACE_Configuration_Section_Key &sect)

void	dump () const
	Diagnostic aid. More...

virtual OPENDDS_STRING	dump_to_str () const

virtual bool	is_reliable () const =0
	Does the transport as configured support RELIABLE_RELIABILITY_QOS? More...

virtual bool	requires_cdr_encapsulation () const
	Does the transport require a CDR-encapsulated data payload? More...

virtual size_t	populate_locator (OpenDDS::DCPS::TransportLocator &trans_info, ConnectionInfoFlags flags) const =0
	Populate a transport locator sequence. Return the number of "locators.". More...

DCPS::WeakRcHandle< ICE::Endpoint >	get_ice_endpoint ()

void	rtps_relay_only_now (bool flag)

void	use_rtps_relay_now (bool flag)

void	use_ice_now (bool flag)

virtual void	update_locators (const GUID_t &, const TransportLocatorSeq &)

virtual void	get_last_recv_locator (const GUID_t &, TransportLocator &)

virtual void	rtps_relay_address_change ()

ReactorTask_rch	reactor_task ()

EventDispatcher_rch	event_dispatcher ()

void	count_messages (bool flag)

bool	count_messages () const

virtual void	append_transport_statistics (TransportStatisticsSequence &)


void	drop_messages (bool flag)

void	drop_messages_m (double m)

void	drop_messages_b (double b)

bool	should_drop (ssize_t length) const

bool	should_drop (const iovec iov[], int n, ssize_t &length) const

Public Member Functions inherited from OpenDDS::DCPS::RcObject
virtual	~RcObject ()

virtual void	_add_ref ()

virtual void	_remove_ref ()

long	ref_count () const

WeakObject *	_get_weak_object () const

Static Public Member Functions
static OPENDDS_STRING	formatNameForDump (const char *name)

Public Attributes
const OPENDDS_STRING	transport_type_

size_t	queue_messages_per_pool_

size_t	queue_initial_pools_

ACE_UINT32	max_packet_size_
	Max size (in bytes) of a packet (packet header + sample(s)) More...

size_t	max_samples_per_packet_
	Max number of samples that should ever be in a single packet. More...

ACE_UINT32	optimum_packet_size_
	Optimum size (in bytes) of a packet (packet header + sample(s)). More...

bool	thread_per_connection_

long	datalink_release_delay_

size_t	datalink_control_chunks_

TimeDuration	fragment_reassembly_timeout_

size_t	receive_preallocated_message_blocks_

size_t	receive_preallocated_data_blocks_

Static Public Attributes
static const long	DEFAULT_DATALINK_RELEASE_DELAY = 10000

static const size_t	DEFAULT_DATALINK_CONTROL_CHUNKS = 32u

Protected Member Functions
	TransportInst (const char *type, const OPENDDS_STRING &name)

virtual	~TransportInst ()

void	set_port_in_addr_string (OPENDDS_STRING &addr_str, u_short port_number)

TransportImpl_rch	get_or_create_impl ()

TransportImpl_rch	get_impl ()

Protected Member Functions inherited from OpenDDS::DCPS::RcObject
	RcObject ()

Protected Attributes
ACE_SYNCH_MUTEX	lock_

bool	shutting_down_

Private Member Functions
void	adjust_config_value ()

void	shutdown ()

virtual TransportImpl_rch	new_impl ()=0

Private Attributes
const OPENDDS_STRING	name_

TransportImpl_rch	impl_

bool	drop_messages_

double	drop_messages_m_

double	drop_messages_b_

bool	count_messages_

ACE_Thread_Mutex	config_lock_

Friends
class	TransportRegistry

class	TransportClient

Detailed Description

Base class to hold configuration settings for TransportImpls.

Each transport implementation will need to define a concrete subclass of the TransportInst class. The base class (TransportInst) contains configuration settings that are common to all (or most) concrete transport implementations. The concrete transport implementation defines any configuration settings that it requires within its concrete subclass of this TransportInst base class.

The TransportInst object is supplied to the TransportImpl::configure() method.

Definition at line 64 of file TransportInst.h.

Constructor & Destructor Documentation

◆ TransportInst()

ACE_INLINE OpenDDS::DCPS::TransportInst::TransportInst	(	const char *	type,
		const OPENDDS_STRING &	name
	)

protected

Definition at line 13 of file TransportInst.inl.

References ACE_INLINE, adjust_config_value(), and DBG_ENTRY_LVL.

   : transport_type_(type)
   , queue_messages_per_pool_(DEFAULT_CONFIG_QUEUE_MESSAGES_PER_POOL)
   , queue_initial_pools_(DEFAULT_CONFIG_QUEUE_INITIAL_POOLS)
   , max_packet_size_(DEFAULT_CONFIG_MAX_PACKET_SIZE)
   , max_samples_per_packet_(DEFAULT_CONFIG_MAX_SAMPLES_PER_PACKET)
   , optimum_packet_size_(DEFAULT_CONFIG_OPTIMUM_PACKET_SIZE)
   , thread_per_connection_(0)
   , datalink_release_delay_(DEFAULT_DATALINK_RELEASE_DELAY)
   , datalink_control_chunks_(DEFAULT_DATALINK_CONTROL_CHUNKS)
   , fragment_reassembly_timeout_(300)
   , receive_preallocated_message_blocks_(0)
   , receive_preallocated_data_blocks_(0)
   , shutting_down_(false)
   , name_(name)
   , drop_messages_(false)
   , drop_messages_m_(0)
   , drop_messages_b_(0)
   , count_messages_(false)
 {
   DBG_ENTRY_LVL("TransportInst", "TransportInst", 6);
   adjust_config_value();
 }

◆ ~TransportInst()

OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL OpenDDS::DCPS::TransportInst::~TransportInst ( )

protectedvirtual

Definition at line 35 of file TransportInst.cpp.

References DBG_ENTRY_LVL.

 {
   DBG_ENTRY_LVL("TransportInst","~TransportInst",6);
 }

Member Function Documentation

◆ adjust_config_value()

ACE_INLINE void OpenDDS::DCPS::TransportInst::adjust_config_value ( )

private

Adjust the configuration values which gives warning on adjusted value.

Definition at line 40 of file TransportInst.inl.

References ACE_DEBUG, ACE_TEXT(), LM_NOTICE, max_samples_per_packet_, and OpenDDS::DCPS::MAX_SEND_BLOCKS.

Referenced by load(), and TransportInst().

 {
   // Ensure that the number of samples put into the packet does
   // not exceed the allowed number of io vectors to be sent by the OS.
   size_t old_value = max_samples_per_packet_;
 
   if ((2 * max_samples_per_packet_ + 1) > MAX_SEND_BLOCKS) {
     max_samples_per_packet_ = (MAX_SEND_BLOCKS + 1) / 2 - 1;
     ACE_DEBUG((LM_NOTICE,
                ACE_TEXT("(%P|%t) NOTICE: \"max_samples_per_packet\" is adjusted from %u to %u\n"),
                old_value, max_samples_per_packet_));
   }
 }

◆ append_transport_statistics()

virtual void OpenDDS::DCPS::TransportInst::append_transport_statistics ( TransportStatisticsSequence & )

inlinevirtual

Reimplemented in OpenDDS::DCPS::RtpsUdpInst.

Definition at line 219 of file TransportInst.h.

References OPENDDS_STRING.

Referenced by OpenDDS::RTPS::Sedp::append_transport_statistics().

219 {}

◆ count_messages() [1/2]

void OpenDDS::DCPS::TransportInst::count_messages ( bool flag )

inline

Definition at line 207 of file TransportInst.h.

References ACE_GUARD.

   {
     ACE_GUARD(ACE_Thread_Mutex, g, config_lock_);
     count_messages_ = flag;
   }

◆ count_messages() [2/2]

bool OpenDDS::DCPS::TransportInst::count_messages ( ) const

inline

Definition at line 213 of file TransportInst.h.

References ACE_GUARD_RETURN.

   {
     ACE_GUARD_RETURN(ACE_Thread_Mutex, g, config_lock_, false);
     return count_messages_;
   }

◆ drop_messages()

void OpenDDS::DCPS::TransportInst::drop_messages ( bool flag )

inline

The RtpsUdpSendStrategy can be configured to simulate a lossy connection by probabilistically not sending RTPS messages. This capability is enabled by setting the flag to true.

The coefficients m and b correspond to a linear model whose argument is the length of the RTPS message. The probablility of dropping the message is p = m * message_length + b. When sending a message, a random number is selected from [0.0, 1.0]. If the random number is less than the drop probability, the message is dropped.

The flag and coefficient can be changed dynamically.

Examples

m = 0 and b = .5 - the probability of dropping a message is .5 regardless of message length.

m = .001 and b = .2 - the probability of dropping a 200-byte message is .4. In this example, all messages longer than 800 bytes will be dropped.

Definition at line 177 of file TransportInst.h.

References ACE_GUARD.

   {
     ACE_GUARD(ACE_Thread_Mutex, g, config_lock_);
     drop_messages_ = flag;
   }

◆ drop_messages_b()

void OpenDDS::DCPS::TransportInst::drop_messages_b ( double b )

inline

The RtpsUdpSendStrategy can be configured to simulate a lossy connection by probabilistically not sending RTPS messages. This capability is enabled by setting the flag to true.

The coefficients m and b correspond to a linear model whose argument is the length of the RTPS message. The probablility of dropping the message is p = m * message_length + b. When sending a message, a random number is selected from [0.0, 1.0]. If the random number is less than the drop probability, the message is dropped.

The flag and coefficient can be changed dynamically.

Examples

m = 0 and b = .5 - the probability of dropping a message is .5 regardless of message length.

m = .001 and b = .2 - the probability of dropping a 200-byte message is .4. In this example, all messages longer than 800 bytes will be dropped.

Definition at line 189 of file TransportInst.h.

References ACE_GUARD.

   {
     ACE_GUARD(ACE_Thread_Mutex, g, config_lock_);
     drop_messages_b_ = b;
   }

◆ drop_messages_m()

void OpenDDS::DCPS::TransportInst::drop_messages_m ( double m )

inline

The RtpsUdpSendStrategy can be configured to simulate a lossy connection by probabilistically not sending RTPS messages. This capability is enabled by setting the flag to true.

The coefficients m and b correspond to a linear model whose argument is the length of the RTPS message. The probablility of dropping the message is p = m * message_length + b. When sending a message, a random number is selected from [0.0, 1.0]. If the random number is less than the drop probability, the message is dropped.

The flag and coefficient can be changed dynamically.

Examples

m = 0 and b = .5 - the probability of dropping a message is .5 regardless of message length.

m = .001 and b = .2 - the probability of dropping a 200-byte message is .4. In this example, all messages longer than 800 bytes will be dropped.

Definition at line 183 of file TransportInst.h.

References ACE_GUARD.

   {
     ACE_GUARD(ACE_Thread_Mutex, g, config_lock_);
     drop_messages_m_ = m;
   }

◆ dump()

void OpenDDS::DCPS::TransportInst::dump ( void ) const

Diagnostic aid.

Definition at line 74 of file TransportInst.cpp.

References ACE_DEBUG, ACE_TEXT(), dump_to_str(), LM_DEBUG, and OPENDDS_STRING.

 {
   ACE_DEBUG((LM_DEBUG,
              ACE_TEXT("\n(%P|%t) TransportInst::dump() -\n%C"),
              dump_to_str().c_str()));
 }

◆ dump_to_str()

OPENDDS_STRING OpenDDS::DCPS::TransportInst::dump_to_str ( ) const

virtual

Reimplemented in OpenDDS::DCPS::MulticastInst, OpenDDS::DCPS::RtpsUdpInst, OpenDDS::DCPS::TcpInst, OpenDDS::DCPS::UdpInst, and OpenDDS::DCPS::ShmemInst.

Definition at line 101 of file TransportInst.cpp.

References datalink_control_chunks_, datalink_release_delay_, formatNameForDump(), fragment_reassembly_timeout_, max_packet_size_, max_samples_per_packet_, name_, OPENDDS_STRING, optimum_packet_size_, queue_initial_pools_, queue_messages_per_pool_, receive_preallocated_data_blocks_, receive_preallocated_message_blocks_, OpenDDS::DCPS::TimeDuration::str(), thread_per_connection_, OpenDDS::DCPS::to_dds_string(), and transport_type_.

Referenced by dump(), OpenDDS::DCPS::ShmemInst::dump_to_str(), OpenDDS::DCPS::UdpInst::dump_to_str(), OpenDDS::DCPS::TcpInst::dump_to_str(), OpenDDS::DCPS::RtpsUdpInst::dump_to_str(), OpenDDS::DCPS::MulticastInst::dump_to_str(), and OpenDDS::DCPS::TransportImpl::dump_to_str().

 {
   OPENDDS_STRING ret;
   ret += formatNameForDump("transport_type")          + transport_type_ + '\n';
   ret += formatNameForDump("name")                    + name_ + '\n';
   ret += formatNameForDump("queue_messages_per_pool") + to_dds_string(unsigned(queue_messages_per_pool_)) + '\n';
   ret += formatNameForDump("queue_initial_pools")     + to_dds_string(unsigned(queue_initial_pools_)) + '\n';
   ret += formatNameForDump("max_packet_size")         + to_dds_string(unsigned(max_packet_size_)) + '\n';
   ret += formatNameForDump("max_samples_per_packet")  + to_dds_string(unsigned(max_samples_per_packet_)) + '\n';
   ret += formatNameForDump("optimum_packet_size")     + to_dds_string(unsigned(optimum_packet_size_)) + '\n';
   ret += formatNameForDump("thread_per_connection")   + (thread_per_connection_ ? "true" : "false") + '\n';
   ret += formatNameForDump("datalink_release_delay")  + to_dds_string(datalink_release_delay_) + '\n';
   ret += formatNameForDump("datalink_control_chunks") + to_dds_string(unsigned(datalink_control_chunks_)) + '\n';
   ret += formatNameForDump("fragment_reassembly_timeout") + fragment_reassembly_timeout_.str() + '\n';
   ret += formatNameForDump("receive_preallocated_message_blocks") + to_dds_string(unsigned(receive_preallocated_message_blocks_)) + '\n';
   ret += formatNameForDump("receive_preallocated_data_blocks") + to_dds_string(unsigned(receive_preallocated_data_blocks_)) + '\n';
   return ret;
 }

◆ event_dispatcher()

OpenDDS::DCPS::EventDispatcher_rch OpenDDS::DCPS::TransportInst::event_dispatcher ( )

Definition at line 223 of file TransportInst.cpp.

References OpenDDS::DCPS::TransportImpl::event_dispatcher(), and get_or_create_impl().

Referenced by OpenDDS::RTPS::Sedp::init().

 {
   const TransportImpl_rch temp = get_or_create_impl();
   return temp ? temp->event_dispatcher() : EventDispatcher_rch();
 }

◆ formatNameForDump()

OPENDDS_STRING OpenDDS::DCPS::TransportInst::formatNameForDump ( const char * name )

static

Format name of transport configuration parameter for use in conjunction with dump(std::ostream& os).

Definition at line 87 of file TransportInst.cpp.

References name(), and OPENDDS_STRING.

Referenced by OpenDDS::DCPS::ShmemInst::dump_to_str(), OpenDDS::DCPS::UdpInst::dump_to_str(), OpenDDS::DCPS::TcpInst::dump_to_str(), OpenDDS::DCPS::RtpsUdpInst::dump_to_str(), dump_to_str(), and OpenDDS::DCPS::MulticastInst::dump_to_str().

 {
   OPENDDS_STRING formatted_name;
   formatted_name.reserve(NAME_INDENT + NAME_WIDTH);
   formatted_name += OPENDDS_STRING(NAME_INDENT, ' ');
   formatted_name += name;
   formatted_name += ":";
   if ((NAME_WIDTH + NAME_INDENT) > formatted_name.length()) {
     formatted_name += OPENDDS_STRING((NAME_WIDTH + NAME_INDENT- formatted_name.length()), ' ');
   }
   return formatted_name;
 }

◆ get_ice_endpoint()

OpenDDS::DCPS::WeakRcHandle< OpenDDS::ICE::Endpoint > OpenDDS::DCPS::TransportInst::get_ice_endpoint ( )

Definition at line 182 of file TransportInst.cpp.

References OpenDDS::DCPS::TransportImpl::get_ice_endpoint(), and get_or_create_impl().

Referenced by OpenDDS::RTPS::Sedp::get_ice_endpoint().

 {
   const OpenDDS::DCPS::TransportImpl_rch temp = get_or_create_impl();
   return temp ? temp->get_ice_endpoint() : OpenDDS::DCPS::WeakRcHandle<OpenDDS::ICE::Endpoint>();
 }

◆ get_impl()

OpenDDS::DCPS::TransportImpl_rch OpenDDS::DCPS::TransportInst::get_impl ( )

protected

Definition at line 149 of file TransportInst.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, impl_, and lock_.

Referenced by OpenDDS::DCPS::RtpsUdpInst::rtps_relay_address_change().

 {
   ACE_GUARD_RETURN(ACE_SYNCH_MUTEX, g, lock_, TransportImpl_rch());
   return impl_;
 }

◆ get_last_recv_locator()

virtual void OpenDDS::DCPS::TransportInst::get_last_recv_locator	(	const GUID_t &	,
		TransportLocator &
	)

inlinevirtual

Reimplemented in OpenDDS::DCPS::RtpsUdpInst.

Definition at line 145 of file TransportInst.h.

Referenced by OpenDDS::RTPS::Sedp::populate_origination_locator().

146 {}

◆ get_or_create_impl()

OpenDDS::DCPS::TransportImpl_rch OpenDDS::DCPS::TransportInst::get_or_create_impl ( )

protected

Definition at line 135 of file TransportInst.cpp.

References ACE_GUARD_RETURN, ACE_SYNCH_MUTEX, impl_, lock_, new_impl(), and shutting_down_.

Referenced by OpenDDS::DCPS::RtpsUdpInst::append_transport_statistics(), OpenDDS::DCPS::TransportClient::enable_transport_using_config(), event_dispatcher(), get_ice_endpoint(), OpenDDS::DCPS::RtpsUdpInst::get_last_recv_locator(), OpenDDS::DCPS::TransportClient::populate_connection_info(), reactor_task(), rtps_relay_only_now(), OpenDDS::DCPS::RtpsUdpInst::update_locators(), use_ice_now(), and use_rtps_relay_now().

 {
   ACE_GUARD_RETURN(ACE_SYNCH_MUTEX, g, lock_, TransportImpl_rch());
   if (!impl_ && !shutting_down_) {
     try {
       impl_ = new_impl();
     } catch (const OpenDDS::DCPS::Transport::UnableToCreate&) {
       return TransportImpl_rch();
     }
   }
   return impl_;
 }

◆ is_reliable()

virtual bool OpenDDS::DCPS::TransportInst::is_reliable ( ) const

pure virtual

Does the transport as configured support RELIABLE_RELIABILITY_QOS?

Implemented in OpenDDS::DCPS::MulticastInst, OpenDDS::DCPS::TcpInst, OpenDDS::DCPS::RtpsUdpInst, OpenDDS::DCPS::ShmemInst, and OpenDDS::DCPS::UdpInst.

Referenced by OpenDDS::DCPS::RecorderImpl::check_transport_qos(), and OpenDDS::DCPS::DataReaderImpl::check_transport_qos().

◆ load()

int OpenDDS::DCPS::TransportInst::load	(	ACE_Configuration_Heap &	cf,
		ACE_Configuration_Section_Key &	sect
	)

virtual

Overwrite the default configurations with the configuration from the given section in the ACE_Configuration_Heap object.

Reimplemented in OpenDDS::DCPS::MulticastInst, OpenDDS::DCPS::RtpsUdpInst, OpenDDS::DCPS::TcpInst, OpenDDS::DCPS::UdpInst, and OpenDDS::DCPS::ShmemInst.

Definition at line 41 of file TransportInst.cpp.

References ACE_DEBUG, ACE_TEXT(), adjust_config_value(), datalink_control_chunks_, datalink_release_delay_, fragment_reassembly_timeout_, GET_CONFIG_TIME_VALUE, GET_CONFIG_VALUE, ACE_Configuration_Heap::get_string_value(), LM_WARNING, max_packet_size_, max_samples_per_packet_, optimum_packet_size_, queue_initial_pools_, queue_messages_per_pool_, receive_preallocated_data_blocks_, receive_preallocated_message_blocks_, and thread_per_connection_.

Referenced by OpenDDS::DCPS::TransportRegistry::create_new_transport_instance_for_participant(), OpenDDS::DCPS::ShmemInst::load(), OpenDDS::DCPS::UdpInst::load(), OpenDDS::DCPS::TcpInst::load(), OpenDDS::DCPS::RtpsUdpInst::load(), and OpenDDS::DCPS::MulticastInst::load().

 {
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("queue_messages_per_pool"), queue_messages_per_pool_, size_t)
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("queue_initial_pools"), queue_initial_pools_, size_t)
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("max_packet_size"), max_packet_size_, ACE_UINT32)
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("max_samples_per_packet"), max_samples_per_packet_, size_t)
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("optimum_packet_size"), optimum_packet_size_, ACE_UINT32)
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("thread_per_connection"), thread_per_connection_, bool)
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("datalink_release_delay"), datalink_release_delay_, int)
   GET_CONFIG_TIME_VALUE(cf, sect, ACE_TEXT("fragment_reassembly_timeout"), fragment_reassembly_timeout_);
 
   // Undocumented - this option is not in the Developer's Guide
   // Controls the number of chunks in the allocators used by the datalink
   // for control messages.
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("datalink_control_chunks"), datalink_control_chunks_, size_t)
 
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("receive_preallocated_message_blocks"), receive_preallocated_message_blocks_, size_t)
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("receive_preallocated_data_blocks"), receive_preallocated_data_blocks_, size_t)
 
   ACE_TString stringvalue;
   if (cf.get_string_value (sect, ACE_TEXT("passive_connect_duration"), stringvalue) == 0) {
     ACE_DEBUG ((LM_WARNING,
                 ACE_TEXT ("(%P|%t) WARNING: passive_connect_duration option ")
                 ACE_TEXT ("is deprecated in the transport inst, must be ")
                 ACE_TEXT ("defined in transport config.\n")));
   }
 
   adjust_config_value();
   return 0;
 }

◆ name()

const OPENDDS_STRING& OpenDDS::DCPS::TransportInst::name ( void ) const

inline

Definition at line 70 of file TransportInst.h.

References load, name, and OPENDDS_STRING.

Referenced by formatNameForDump(), OpenDDS::DCPS::TransportRegistry::remove_inst(), OpenDDS::DCPS::ShmemInst::ShmemInst(), and OpenDDS::DCPS::TransportConfig::sorted_insert().

70 { return name_; }

OpenDDS::DCPS::TransportInst::name_

const OPENDDS_STRING name_

Definition: TransportInst.h:249

◆ new_impl()

virtual TransportImpl_rch OpenDDS::DCPS::TransportInst::new_impl ( )

privatepure virtual

Implemented in OpenDDS::DCPS::RtpsUdpInst, OpenDDS::DCPS::TcpInst, OpenDDS::DCPS::MulticastInst, OpenDDS::DCPS::UdpInst, and OpenDDS::DCPS::ShmemInst.

Referenced by get_or_create_impl().

◆ populate_locator()

virtual size_t OpenDDS::DCPS::TransportInst::populate_locator	(	OpenDDS::DCPS::TransportLocator &	trans_info,
		ConnectionInfoFlags	flags
	)		const

pure virtual

Populate a transport locator sequence. Return the number of "locators.".

Implemented in OpenDDS::DCPS::MulticastInst, OpenDDS::DCPS::TcpInst, OpenDDS::DCPS::RtpsUdpInst, OpenDDS::DCPS::ShmemInst, and OpenDDS::DCPS::UdpInst.

Referenced by OpenDDS::RTPS::Sedp::multicast_locators(), and OpenDDS::RTPS::Sedp::unicast_locators().

◆ reactor_task()

OpenDDS::DCPS::ReactorTask_rch OpenDDS::DCPS::TransportInst::reactor_task ( )

Definition at line 216 of file TransportInst.cpp.

References get_or_create_impl(), and OpenDDS::DCPS::TransportImpl::reactor_task().

Referenced by OpenDDS::RTPS::Sedp::init().

 {
   const OpenDDS::DCPS::TransportImpl_rch temp = get_or_create_impl();
   return temp ? temp->reactor_task() : OpenDDS::DCPS::ReactorTask_rch();
 }

◆ requires_cdr_encapsulation()

virtual bool OpenDDS::DCPS::TransportInst::requires_cdr_encapsulation ( ) const

inlinevirtual

Does the transport require a CDR-encapsulated data payload?

Reimplemented in OpenDDS::DCPS::RtpsUdpInst.

Definition at line 132 of file TransportInst.h.

Referenced by OpenDDS::DCPS::TransportClient::enable_transport_using_config().

132 { return false; }

◆ rtps_relay_address_change()

virtual void OpenDDS::DCPS::TransportInst::rtps_relay_address_change ( )

inlinevirtual

Reimplemented in OpenDDS::DCPS::RtpsUdpInst.

Definition at line 148 of file TransportInst.h.

148 {}

◆ rtps_relay_only_now()

void OpenDDS::DCPS::TransportInst::rtps_relay_only_now ( bool flag )

Definition at line 189 of file TransportInst.cpp.

References get_or_create_impl(), and OpenDDS::DCPS::TransportImpl::rtps_relay_only_now().

Referenced by OpenDDS::RTPS::Sedp::rtps_relay_only_now().

 {
   const OpenDDS::DCPS::TransportImpl_rch temp = get_or_create_impl();
   if (temp) {
     temp->rtps_relay_only_now(flag);
   }
 }

◆ set_port_in_addr_string()

void OpenDDS::DCPS::TransportInst::set_port_in_addr_string	(	OPENDDS_STRING &	addr_str,
		u_short	port_number
	)

protected

Definition at line 156 of file TransportInst.cpp.

References ACE_OS::snprintf().

 {
 #ifdef BUFSIZE
 #undef BUFSIZE
 #endif
   const int BUFSIZE=1024;
   char result[BUFSIZE];
 
   if (std::count(addr_str.begin(), addr_str.end(), ':') < 2) {
     OPENDDS_STRING::size_type pos = addr_str.find_last_of(":");
     ACE_OS::snprintf(result, BUFSIZE, "%.*s:%hu", static_cast<int>(pos), addr_str.c_str(), port_number);
   }
   else {
     // this is the numeric form of ipv6 address because it has more than one ':'
     if (addr_str[0] != '[') {
       ACE_OS::snprintf(result, BUFSIZE, "[%s]:%hu", addr_str.c_str(), port_number);
     }
     else {
       OPENDDS_STRING::size_type pos = addr_str.find_last_of("]");
       ACE_OS::snprintf(result, BUFSIZE, "%.*s:%hu", static_cast<int>(pos+1), addr_str.c_str(), port_number);
     }
   }
   addr_str = result;
 }

◆ should_drop() [1/2]

bool OpenDDS::DCPS::TransportInst::should_drop ( ssize_t length ) const

The RtpsUdpSendStrategy can be configured to simulate a lossy connection by probabilistically not sending RTPS messages. This capability is enabled by setting the flag to true.

The coefficients m and b correspond to a linear model whose argument is the length of the RTPS message. The probablility of dropping the message is p = m * message_length + b. When sending a message, a random number is selected from [0.0, 1.0]. If the random number is less than the drop probability, the message is dropped.

The flag and coefficient can be changed dynamically.

Examples

m = 0 and b = .5 - the probability of dropping a message is .5 regardless of message length.

m = .001 and b = .2 - the probability of dropping a 200-byte message is .4. In this example, all messages longer than 800 bytes will be dropped.

Definition at line 230 of file TransportInst.cpp.

References ACE_ERROR, ACE_GUARD_RETURN, config_lock_, drop_messages_, drop_messages_b_, drop_messages_m_, LM_ERROR, and OPENDDS_END_VERSIONED_NAMESPACE_DECL.

 {
 #ifdef OPENDDS_TESTING_FEATURES
   ACE_GUARD_RETURN(ACE_Thread_Mutex, g, config_lock_, false);
   return drop_messages_ && (OPENDDS_DRAND48() < (length * drop_messages_m_ + drop_messages_b_));
 #else
   ACE_UNUSED_ARG(length);
   ACE_ERROR((LM_ERROR,
              "(%P|%t) ERROR: TransportInst::should_drop: "
              "caller not conditioned on OPENDDS_TESTING_FEATURES\n"));
   return false;
 #endif
 }

◆ should_drop() [2/2]

bool OpenDDS::DCPS::TransportInst::should_drop	(	const iovec	iov[],
		int	n,
		ssize_t &	length
	)		const

inline

The RtpsUdpSendStrategy can be configured to simulate a lossy connection by probabilistically not sending RTPS messages. This capability is enabled by setting the flag to true.

The coefficients m and b correspond to a linear model whose argument is the length of the RTPS message. The probablility of dropping the message is p = m * message_length + b. When sending a message, a random number is selected from [0.0, 1.0]. If the random number is less than the drop probability, the message is dropped.

The flag and coefficient can be changed dynamically.

Examples

m = 0 and b = .5 - the probability of dropping a message is .5 regardless of message length.

m = .001 and b = .2 - the probability of dropping a 200-byte message is .4. In this example, all messages longer than 800 bytes will be dropped.

Definition at line 197 of file TransportInst.h.

   {
     length = 0;
     for (int i = 0; i < n; ++i) {
       length += iov[i].iov_len;
     }
     return should_drop(length);
   }

◆ shutdown()

void OpenDDS::DCPS::TransportInst::shutdown ( void )

private

Definition at line 121 of file TransportInst.cpp.

References ACE_GUARD, ACE_SYNCH_MUTEX, impl_, lock_, OpenDDS::DCPS::TransportImpl::shutdown(), shutting_down_, and OpenDDS::DCPS::RcHandle< T >::swap().

Referenced by OpenDDS::DCPS::TransportRegistry::remove_inst().

 {
   TransportImpl_rch impl;
   {
     ACE_GUARD(ACE_SYNCH_MUTEX, g, lock_);
     impl_.swap(impl);
     shutting_down_ = true;
   }
   if (impl) {
     impl->shutdown();
   }
 }

◆ update_locators()

virtual void OpenDDS::DCPS::TransportInst::update_locators	(	const GUID_t &	,
		const TransportLocatorSeq &
	)

inlinevirtual

Reimplemented in OpenDDS::DCPS::RtpsUdpInst.

Definition at line 142 of file TransportInst.h.

Referenced by OpenDDS::RTPS::Sedp::update_locators().

143 {}

◆ use_ice_now()

void OpenDDS::DCPS::TransportInst::use_ice_now ( bool flag )

Definition at line 207 of file TransportInst.cpp.

References get_or_create_impl(), and OpenDDS::DCPS::TransportImpl::use_ice_now().

Referenced by OpenDDS::RTPS::Sedp::use_ice_now().

 {
   const OpenDDS::DCPS::TransportImpl_rch temp = get_or_create_impl();
   if (temp) {
     temp->use_ice_now(flag);
   }
 }

◆ use_rtps_relay_now()

void OpenDDS::DCPS::TransportInst::use_rtps_relay_now ( bool flag )

Definition at line 198 of file TransportInst.cpp.

References get_or_create_impl(), and OpenDDS::DCPS::TransportImpl::use_rtps_relay_now().

Referenced by OpenDDS::RTPS::Sedp::use_rtps_relay_now().

 {
   const OpenDDS::DCPS::TransportImpl_rch temp = get_or_create_impl();
   if (temp) {
     temp->use_rtps_relay_now(flag);
   }
 }

Friends And Related Function Documentation

◆ TransportClient

friend class TransportClient

friend

Definition at line 242 of file TransportInst.h.

◆ TransportRegistry

friend class TransportRegistry

friend

Definition at line 239 of file TransportInst.h.

Member Data Documentation

◆ config_lock_

ACE_Thread_Mutex OpenDDS::DCPS::TransportInst::config_lock_

mutableprivate

Definition at line 259 of file TransportInst.h.

Referenced by should_drop().

◆ count_messages_

bool OpenDDS::DCPS::TransportInst::count_messages_

private

Definition at line 257 of file TransportInst.h.

◆ datalink_control_chunks_

size_t OpenDDS::DCPS::TransportInst::datalink_control_chunks_

The number of chunks used to size allocators for transport control samples. The default value is 32.

Definition at line 114 of file TransportInst.h.

Referenced by OpenDDS::DCPS::DataLink::DataLink(), dump_to_str(), and load().

◆ datalink_release_delay_

long OpenDDS::DCPS::TransportInst::datalink_release_delay_

Delay in milliseconds that the datalink should be released after all associations are removed. The default value is 10 seconds.

Definition at line 110 of file TransportInst.h.

Referenced by OpenDDS::DCPS::DataLink::DataLink(), dump_to_str(), TAO_DDS_DCPSInfo_i::init_transport(), and load().

◆ DEFAULT_DATALINK_CONTROL_CHUNKS

const size_t OpenDDS::DCPS::TransportInst::DEFAULT_DATALINK_CONTROL_CHUNKS = 32u

static

Definition at line 68 of file TransportInst.h.

Referenced by OpenDDS::DCPS::DataLink::DataLink().

◆ DEFAULT_DATALINK_RELEASE_DELAY

const long OpenDDS::DCPS::TransportInst::DEFAULT_DATALINK_RELEASE_DELAY = 10000

static

Definition at line 67 of file TransportInst.h.

Referenced by OpenDDS::DCPS::DataLink::DataLink().

◆ drop_messages_

bool OpenDDS::DCPS::TransportInst::drop_messages_

private

Definition at line 253 of file TransportInst.h.

Referenced by should_drop().

◆ drop_messages_b_

double OpenDDS::DCPS::TransportInst::drop_messages_b_

private

Definition at line 255 of file TransportInst.h.

Referenced by should_drop().

◆ drop_messages_m_

double OpenDDS::DCPS::TransportInst::drop_messages_m_

private

Definition at line 254 of file TransportInst.h.

Referenced by should_drop().

◆ fragment_reassembly_timeout_

TimeDuration OpenDDS::DCPS::TransportInst::fragment_reassembly_timeout_

Maximum time to store incoming fragments of incomplete data samples. The expiration time is relative to the last received fragment.

Definition at line 118 of file TransportInst.h.

Referenced by dump_to_str(), and load().

◆ impl_

TransportImpl_rch OpenDDS::DCPS::TransportInst::impl_

private

Definition at line 251 of file TransportInst.h.

Referenced by get_impl(), get_or_create_impl(), and shutdown().

◆ lock_

ACE_SYNCH_MUTEX OpenDDS::DCPS::TransportInst::lock_

mutableprotected

Definition at line 230 of file TransportInst.h.

Referenced by get_impl(), get_or_create_impl(), and shutdown().

◆ max_packet_size_

ACE_UINT32 OpenDDS::DCPS::TransportInst::max_packet_size_

Max size (in bytes) of a packet (packet header + sample(s))

Definition at line 96 of file TransportInst.h.

Referenced by dump_to_str(), load(), and OpenDDS::DCPS::TransportSendStrategy::TransportSendStrategy().

◆ max_samples_per_packet_

size_t OpenDDS::DCPS::TransportInst::max_samples_per_packet_

Max number of samples that should ever be in a single packet.

Definition at line 99 of file TransportInst.h.

Referenced by adjust_config_value(), dump_to_str(), load(), and OpenDDS::DCPS::TransportSendStrategy::TransportSendStrategy().

◆ name_

const OPENDDS_STRING OpenDDS::DCPS::TransportInst::name_

private

Definition at line 249 of file TransportInst.h.

Referenced by dump_to_str().

◆ optimum_packet_size_

ACE_UINT32 OpenDDS::DCPS::TransportInst::optimum_packet_size_

Optimum size (in bytes) of a packet (packet header + sample(s)).

Definition at line 102 of file TransportInst.h.

Referenced by dump_to_str(), load(), and OpenDDS::DCPS::TransportSendStrategy::TransportSendStrategy().

◆ queue_initial_pools_

size_t OpenDDS::DCPS::TransportInst::queue_initial_pools_

Initial number of pre-allocated pools of link (list) objects for the "send queue" of each DataLink.

Definition at line 93 of file TransportInst.h.

Referenced by dump_to_str(), and load().

◆ queue_messages_per_pool_

size_t OpenDDS::DCPS::TransportInst::queue_messages_per_pool_

Number of pre-created link (list) objects per pool for the "send queue" of each DataLink.

Definition at line 89 of file TransportInst.h.

Referenced by dump_to_str(), and load().

◆ receive_preallocated_data_blocks_

size_t OpenDDS::DCPS::TransportInst::receive_preallocated_data_blocks_

Preallocated chunks in allocator for data blocks and data buffers. Default (0) is to use built-in constants in TransportReceiveStrategy

Definition at line 126 of file TransportInst.h.

Referenced by dump_to_str(), and load().

◆ receive_preallocated_message_blocks_

size_t OpenDDS::DCPS::TransportInst::receive_preallocated_message_blocks_

Preallocated chunks in allocator for message blocks. Default (0) is to use built-in constants in TransportReceiveStrategy

Definition at line 122 of file TransportInst.h.

Referenced by dump_to_str(), and load().

◆ shutting_down_

bool OpenDDS::DCPS::TransportInst::shutting_down_

protected

Definition at line 231 of file TransportInst.h.

Referenced by get_or_create_impl(), and shutdown().

◆ thread_per_connection_

bool OpenDDS::DCPS::TransportInst::thread_per_connection_

Flag for whether a new thread is needed for connection to send without backpressure.

Definition at line 106 of file TransportInst.h.

Referenced by OpenDDS::DCPS::DataLink::DataLink(), dump_to_str(), and load().

◆ transport_type_

const OPENDDS_STRING OpenDDS::DCPS::TransportInst::transport_type_

Definition at line 85 of file TransportInst.h.

Referenced by dump_to_str().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ TransportInst()

◆ ~TransportInst()

Member Function Documentation

◆ adjust_config_value()

◆ append_transport_statistics()

◆ count_messages() [1/2]

◆ count_messages() [2/2]

◆ drop_messages()

◆ drop_messages_b()

◆ drop_messages_m()

◆ dump()

◆ dump_to_str()

◆ event_dispatcher()

◆ formatNameForDump()

◆ get_ice_endpoint()

◆ get_impl()

◆ get_last_recv_locator()

◆ get_or_create_impl()

◆ is_reliable()

◆ load()

◆ name()

◆ new_impl()

◆ populate_locator()

◆ reactor_task()

◆ requires_cdr_encapsulation()

◆ rtps_relay_address_change()

◆ rtps_relay_only_now()

◆ set_port_in_addr_string()

◆ should_drop() [1/2]

◆ should_drop() [2/2]

◆ shutdown()

◆ update_locators()

◆ use_ice_now()

◆ use_rtps_relay_now()

Friends And Related Function Documentation

◆ TransportClient

◆ TransportRegistry

Member Data Documentation

◆ config_lock_

◆ count_messages_

◆ datalink_control_chunks_

◆ datalink_release_delay_

◆ DEFAULT_DATALINK_CONTROL_CHUNKS

◆ DEFAULT_DATALINK_RELEASE_DELAY

◆ drop_messages_

◆ drop_messages_b_

◆ drop_messages_m_

◆ fragment_reassembly_timeout_

◆ impl_

◆ lock_

◆ max_packet_size_

◆ max_samples_per_packet_

◆ name_

◆ optimum_packet_size_

◆ queue_initial_pools_

◆ queue_messages_per_pool_

◆ receive_preallocated_data_blocks_

◆ receive_preallocated_message_blocks_

◆ shutting_down_

◆ thread_per_connection_

◆ transport_type_