#include <TcpInst.h>

Inheritance diagram for OpenDDS::DCPS::TcpInst:

Collaboration diagram for OpenDDS::DCPS::TcpInst:

[legend]

Public Member Functions
virtual int	load (ACE_Configuration_Heap &cf, ACE_Configuration_Section_Key &sect)

virtual OPENDDS_STRING	dump_to_str () const
	Diagnostic aid. More...

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

const std::string &	get_public_address () const

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

OPENDDS_STRING	local_address_string () const

ACE_INET_Addr	local_address () const

void	local_address (const ACE_INET_Addr &addr)

void	local_address (const char *str)

void	local_address (u_short port_number, const char *host_name)

void	local_address_set_port (u_short port_number)

Public Member Functions inherited from OpenDDS::DCPS::TransportInst
const OPENDDS_STRING &	name () const

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

virtual bool	requires_cdr_encapsulation () const
	Does the transport require a CDR-encapsulated data payload? 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

Public Attributes
std::string	pub_address_str_

bool	enable_nagle_algorithm_

int	conn_retry_initial_delay_

double	conn_retry_backoff_multiplier_

int	conn_retry_attempts_

int	max_output_pause_period_

int	passive_reconnect_duration_

int	active_conn_timeout_period_

Public Attributes inherited from OpenDDS::DCPS::TransportInst
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 int	DEFAULT_PASSIVE_RECONNECT_DURATION = 2000

static const int	DEFAULT_ACTIVE_CONN_TIMEOUT_PERIOD = 5000

Static Public Attributes inherited from OpenDDS::DCPS::TransportInst
static const long	DEFAULT_DATALINK_RELEASE_DELAY = 10000

static const size_t	DEFAULT_DATALINK_CONTROL_CHUNKS = 32u

Private Member Functions
	TcpInst (const OPENDDS_STRING &name)

virtual	~TcpInst ()

TransportImpl_rch	new_impl ()

Private Attributes
ACE_INET_Addr	local_address_

std::string	local_address_str_

Friends
class	TcpType

class	TcpTransport

class	::DDS_TEST

template<typename T , typename U >
RcHandle< T >	OpenDDS::DCPS::make_rch (U const &)

Additional Inherited Members
Static Public Member Functions inherited from OpenDDS::DCPS::TransportInst
static OPENDDS_STRING	formatNameForDump (const char *name)

Protected Member Functions inherited from OpenDDS::DCPS::TransportInst
	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 inherited from OpenDDS::DCPS::TransportInst
ACE_SYNCH_MUTEX	lock_

bool	shutting_down_

Detailed Description

Definition at line 32 of file TcpInst.h.

Constructor & Destructor Documentation

◆ TcpInst()

OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL ACE_INLINE OpenDDS::DCPS::TcpInst::TcpInst ( const OPENDDS_STRING & name )

explicitprivate

Definition at line 13 of file TcpInst.inl.

References DBG_ENTRY_LVL, and OPENDDS_END_VERSIONED_NAMESPACE_DECL.

   : TransportInst("tcp", name),
     enable_nagle_algorithm_(false),
     conn_retry_initial_delay_(500),
     conn_retry_backoff_multiplier_(2.0),
     conn_retry_attempts_(3),
     max_output_pause_period_(-1),
     passive_reconnect_duration_(DEFAULT_PASSIVE_RECONNECT_DURATION),
     active_conn_timeout_period_(DEFAULT_ACTIVE_CONN_TIMEOUT_PERIOD)
 {
   DBG_ENTRY_LVL("TcpInst", "TcpInst", 6);
 }

◆ ~TcpInst()

OPENDDS_BEGIN_VERSIONED_NAMESPACE_DECL OpenDDS::DCPS::TcpInst::~TcpInst ( )

privatevirtual

Definition at line 23 of file TcpInst.cpp.

References DBG_ENTRY_LVL.

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

Member Function Documentation

◆ dump_to_str()

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

virtual

Diagnostic aid.

Reimplemented from OpenDDS::DCPS::TransportInst.

Definition at line 74 of file TcpInst.cpp.

References active_conn_timeout_period_, conn_retry_attempts_, conn_retry_backoff_multiplier_, conn_retry_initial_delay_, OpenDDS::DCPS::TransportInst::dump_to_str(), enable_nagle_algorithm_, OpenDDS::DCPS::TransportInst::formatNameForDump(), local_address_string(), max_output_pause_period_, OPENDDS_STRING, passive_reconnect_duration_, and pub_address_str_.

 {
   std::ostringstream os;
   os << TransportInst::dump_to_str();
 
   os << formatNameForDump("local_address")                 << this->local_address_string() << std::endl;
   os << formatNameForDump("pub_address")                   << this->pub_address_str_ << std::endl;
   os << formatNameForDump("enable_nagle_algorithm")        << (this->enable_nagle_algorithm_ ? "true" : "false") << std::endl;
   os << formatNameForDump("conn_retry_initial_delay")      << this->conn_retry_initial_delay_ << std::endl;
   os << formatNameForDump("conn_retry_backoff_multiplier") << this->conn_retry_backoff_multiplier_ << std::endl;
   os << formatNameForDump("conn_retry_attempts")           << this->conn_retry_attempts_ << std::endl;
   os << formatNameForDump("passive_reconnect_duration")    << this->passive_reconnect_duration_ << std::endl;
   os << formatNameForDump("max_output_pause_period")       << this->max_output_pause_period_ << std::endl;
   os << formatNameForDump("active_conn_timeout_period")    << this->active_conn_timeout_period_ << std::endl;
   return OPENDDS_STRING(os.str());
 }

◆ get_public_address()

const std::string& OpenDDS::DCPS::TcpInst::get_public_address ( ) const

inline

The public address is our publicly advertised address. Usually this is the same as the local address, but if a public address is explicitly specified, use that.

Definition at line 100 of file TcpInst.h.

Referenced by populate_locator().

                                               {
     return (pub_address_str_ == "") ? local_address_str_ : pub_address_str_;
   }

◆ is_reliable()

bool OpenDDS::DCPS::TcpInst::is_reliable ( ) const

inlinevirtual

Does the transport as configured support RELIABLE_RELIABILITY_QOS?

Implements OpenDDS::DCPS::TransportInst.

Definition at line 95 of file TcpInst.h.

95 { return true; }

◆ load()

int OpenDDS::DCPS::TcpInst::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 from OpenDDS::DCPS::TransportInst.

Definition at line 35 of file TcpInst.cpp.

References ACE_TEXT(), active_conn_timeout_period_, conn_retry_attempts_, conn_retry_backoff_multiplier_, conn_retry_initial_delay_, enable_nagle_algorithm_, GET_CONFIG_DOUBLE_VALUE, GET_CONFIG_STRING_VALUE, GET_CONFIG_VALUE, OpenDDS::DCPS::TransportInst::load(), local_address(), max_output_pause_period_, OPENDDS_STRING, passive_reconnect_duration_, and pub_address_str_.

 {
   TransportInst::load(cf, trans_sect);
 
   std::string local_address;
   GET_CONFIG_STRING_VALUE(cf, trans_sect, ACE_TEXT("local_address"), local_address);
 
   if (!local_address.empty()) {
     this->local_address(local_address.c_str());
   }
 
   GET_CONFIG_STRING_VALUE(cf, trans_sect, ACE_TEXT("pub_address"), pub_address_str_);
 
   GET_CONFIG_VALUE(cf, trans_sect, ACE_TEXT("enable_nagle_algorithm"),
                    this->enable_nagle_algorithm_, bool)
 
   GET_CONFIG_VALUE(cf, trans_sect, ACE_TEXT("conn_retry_initial_delay"),
                    this->conn_retry_initial_delay_, int)
 
   GET_CONFIG_DOUBLE_VALUE(cf, trans_sect, ACE_TEXT("conn_retry_backoff_multiplier"),
                    this->conn_retry_backoff_multiplier_)
 
   GET_CONFIG_VALUE(cf, trans_sect, ACE_TEXT("conn_retry_attempts"),
                    this->conn_retry_attempts_, int)
 
   GET_CONFIG_VALUE(cf, trans_sect, ACE_TEXT("passive_reconnect_duration"),
                    this->passive_reconnect_duration_, int)
 
   GET_CONFIG_VALUE(cf, trans_sect, ACE_TEXT("max_output_pause_period"),
                    this->max_output_pause_period_, int)
 
   GET_CONFIG_VALUE(cf, trans_sect, ACE_TEXT("active_conn_timeout_period"),
                    this->active_conn_timeout_period_, int)
 
   return 0;
 }

◆ local_address() [1/4]

ACE_INET_Addr OpenDDS::DCPS::TcpInst::local_address ( ) const

inline

Definition at line 107 of file TcpInst.h.

Referenced by load(), and populate_locator().

107 { return local_address_; }

OpenDDS::DCPS::TcpInst::local_address_

ACE_INET_Addr local_address_

Definition: TcpInst.h:142

◆ local_address() [2/4]

void OpenDDS::DCPS::TcpInst::local_address ( const ACE_INET_Addr & addr )

inline

Definition at line 108 of file TcpInst.h.

References OpenDDS::DCPS::LogAddr::str().

   {
     local_address_ = addr;
     local_address_str_ = LogAddr(addr).str();
   }

◆ local_address() [3/4]

void OpenDDS::DCPS::TcpInst::local_address ( const char * str )

inline

Definition at line 113 of file TcpInst.h.

References OpenDDS::DCPS::choose_single_coherent_address().

   {
     local_address_str_ = str;
     local_address_ = choose_single_coherent_address(local_address_str_, false);
   }

◆ local_address() [4/4]

void OpenDDS::DCPS::TcpInst::local_address	(	u_short	port_number,
		const char *	host_name
	)

inline

Definition at line 118 of file TcpInst.h.

References OpenDDS::DCPS::choose_single_coherent_address(), and OpenDDS::DCPS::to_dds_string().

   {
     local_address_str_ = host_name;
     local_address_str_ += ":" + to_dds_string(port_number);
     local_address_ = choose_single_coherent_address(local_address_str_, false);
   }

◆ local_address_set_port()

void OpenDDS::DCPS::TcpInst::local_address_set_port ( u_short port_number )

inline

Definition at line 124 of file TcpInst.h.

                                                    {
     local_address_.set_port_number(port_number);
     set_port_in_addr_string(local_address_str_, port_number);
   }

◆ local_address_string()

OPENDDS_STRING OpenDDS::DCPS::TcpInst::local_address_string ( ) const

inline

Definition at line 106 of file TcpInst.h.

Referenced by dump_to_str().

106 { return local_address_str_; }

OpenDDS::DCPS::TcpInst::local_address_str_

std::string local_address_str_

Definition: TcpInst.h:148

◆ new_impl()

OpenDDS::DCPS::TransportImpl_rch OpenDDS::DCPS::TcpInst::new_impl ( )

privatevirtual

Implements OpenDDS::DCPS::TransportInst.

Definition at line 29 of file TcpInst.cpp.

References OpenDDS::DCPS::rchandle_from().

 {
   return make_rch<TcpTransport>(rchandle_from(this));
 }

◆ populate_locator()

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

virtual

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

Implements OpenDDS::DCPS::TransportInst.

Definition at line 92 of file TcpInst.cpp.

References ACE_OutputCDR::buffer(), OpenDDS::DCPS::TransportLocator::data, get_public_address(), local_address(), OPENDDS_END_VERSIONED_NAMESPACE_DECL, pub_address_str_, ACE_OutputCDR::total_length(), and OpenDDS::DCPS::TransportLocator::transport_type.

 {
   if (local_address() != ACE_INET_Addr() || !pub_address_str_.empty()) {
     // Get the public address string from the inst (usually the local address)
     NetworkResource network_resource(get_public_address());
 
     ACE_OutputCDR cdr;
     cdr << network_resource;
     const CORBA::ULong len = static_cast<CORBA::ULong>(cdr.total_length());
     char* buffer = const_cast<char*>(cdr.buffer()); // safe
 
     local_info.transport_type = "tcp";
     local_info.data = TransportBLOB(len, len,
                                     reinterpret_cast<CORBA::Octet*>(buffer));
     return 1;
   } else {
     return 0;
   }
 }

Friends And Related Function Documentation

◆ ::DDS_TEST

friend class ::DDS_TEST

friend

Definition at line 132 of file TcpInst.h.

◆ OpenDDS::DCPS::make_rch

template<typename T , typename U >

RcHandle<T> OpenDDS::DCPS::make_rch ( U const & )

friend

◆ TcpTransport

friend class TcpTransport

friend

Definition at line 131 of file TcpInst.h.

◆ TcpType

friend class TcpType

friend

Definition at line 130 of file TcpInst.h.

Member Data Documentation

◆ active_conn_timeout_period_

int OpenDDS::DCPS::TcpInst::active_conn_timeout_period_

The time period in milliseconds for the acceptor side of a connection to wait for the connection to be established. If not connected within this period then this link is removed from pending and any other links are attempted. The default is 5 seconds (5000 millseconds).

Definition at line 93 of file TcpInst.h.

Referenced by dump_to_str(), and load().

◆ conn_retry_attempts_

int OpenDDS::DCPS::TcpInst::conn_retry_attempts_

Number of attempts to reconnect before giving up and calling on_publication_lost() and on_subscription_lost() callbacks. The default is 3.

Definition at line 71 of file TcpInst.h.

Referenced by dump_to_str(), and load().

◆ conn_retry_backoff_multiplier_

double OpenDDS::DCPS::TcpInst::conn_retry_backoff_multiplier_

The backoff multiplier for reconnection strategy. The third and so on reconnect will be this value * the previous delay. Hence with conn_retry_initial_delay=500 and conn_retry_backoff_multiplier=1.5 the second reconnect attempt will be at 0.5 seconds after first retry connect fails; the third attempt will be 0.75 seconds after the second retry connect fails; the fourth attempt will be 1.125 seconds after the third retry connect fails. The default value is 2.0.

Definition at line 66 of file TcpInst.h.

Referenced by dump_to_str(), and load().

◆ conn_retry_initial_delay_

int OpenDDS::DCPS::TcpInst::conn_retry_initial_delay_

The initial retry delay in milliseconds. The first connection retry will be when the loss of connection is detected. The second try will be after this delay. The default is 500 miliseconds.

Definition at line 56 of file TcpInst.h.

Referenced by dump_to_str(), and load().

◆ DEFAULT_ACTIVE_CONN_TIMEOUT_PERIOD

const int OpenDDS::DCPS::TcpInst::DEFAULT_ACTIVE_CONN_TIMEOUT_PERIOD = 5000

static

Definition at line 37 of file TcpInst.h.

◆ DEFAULT_PASSIVE_RECONNECT_DURATION

const int OpenDDS::DCPS::TcpInst::DEFAULT_PASSIVE_RECONNECT_DURATION = 2000

static

Definition at line 36 of file TcpInst.h.

◆ enable_nagle_algorithm_

bool OpenDDS::DCPS::TcpInst::enable_nagle_algorithm_

Definition at line 50 of file TcpInst.h.

Referenced by dump_to_str(), and load().

◆ local_address_

ACE_INET_Addr OpenDDS::DCPS::TcpInst::local_address_

private

Describes the local endpoint to be used to accept passive connections.

Definition at line 142 of file TcpInst.h.

◆ local_address_str_

std::string OpenDDS::DCPS::TcpInst::local_address_str_

private

The address string used to configure the acceptor. This string is either from configuration file or default to hostname:port. The hostname is fully qualified hostname and the port is randomly picked by os.

Definition at line 148 of file TcpInst.h.

◆ max_output_pause_period_

int OpenDDS::DCPS::TcpInst::max_output_pause_period_

Maximum period (in milliseconds) of not being able to send queued messages. If there are samples queued and no output for longer than this period then the connection will be closed and on_*_lost() callbacks will be called. If the value is zero, the default, then this check will not be made.

Definition at line 78 of file TcpInst.h.

Referenced by dump_to_str(), and load().

◆ passive_reconnect_duration_

int OpenDDS::DCPS::TcpInst::passive_reconnect_duration_

The time period in milliseconds for the acceptor side of a connection to wait for the connection to be reconnected. If not reconnected within this period then on_publication_lost() and on_subscription_lost() callbacks will be called. The default is 2 seconds (2000 millseconds).

Definition at line 86 of file TcpInst.h.

Referenced by dump_to_str(), and load().

◆ pub_address_str_

std::string OpenDDS::DCPS::TcpInst::pub_address_str_

The address string provided to DCPSInfoRepo for connectors. This string is either from configuration file or defaults to the local address.

Definition at line 48 of file TcpInst.h.

Referenced by dump_to_str(), load(), and populate_locator().

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

Public Member Functions

Public Attributes

Static Public Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ TcpInst()

◆ ~TcpInst()

Member Function Documentation

◆ dump_to_str()

◆ get_public_address()

◆ is_reliable()

◆ load()

◆ local_address() [1/4]

◆ local_address() [2/4]

◆ local_address() [3/4]

◆ local_address() [4/4]

◆ local_address_set_port()

◆ local_address_string()

◆ new_impl()

◆ populate_locator()

Friends And Related Function Documentation

◆ ::DDS_TEST

◆ OpenDDS::DCPS::make_rch

◆ TcpTransport

◆ TcpType

Member Data Documentation

◆ active_conn_timeout_period_

◆ conn_retry_attempts_

◆ conn_retry_backoff_multiplier_

◆ conn_retry_initial_delay_

◆ DEFAULT_ACTIVE_CONN_TIMEOUT_PERIOD

◆ DEFAULT_PASSIVE_RECONNECT_DURATION

◆ enable_nagle_algorithm_

◆ local_address_

◆ local_address_str_

◆ max_output_pause_period_

◆ passive_reconnect_duration_

◆ pub_address_str_