OpenDDS::DCPS::TcpInst Class Reference

#include <TcpInst.h>

Inheritance diagram for OpenDDS::DCPS::TcpInst:

[legend]Collaboration diagram for OpenDDS::DCPS::TcpInst:

[legend]List of all members.

Public Member Functions
virtual int	load (ACE_Configuration_Heap &cf, ACE_Configuration_Section_Key &sect)
virtual OPENDDS_STRING	dump_to_str ()
	Diagnostic aid.
bool	is_reliable () const
	Does the transport as configured support RELIABLE_RELIABILITY_QOS?
const std::string &	get_public_address () const
virtual size_t	populate_locator (OpenDDS::DCPS::TransportLocator &trans_info) const
	Populate a transport locator sequence. Return the number of "locators.".
OPENDDS_STRING	local_address_string () const
ACE_INET_Addr	local_address () const
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 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_
Private Member Functions
	TcpInst (const OPENDDS_STRING &name)
virtual	~TcpInst ()
TcpTransport *	new_impl (const TransportInst_rch &inst)
Private Attributes
ACE_INET_Addr	local_address_
std::string	local_address_str_
Friends
class	TcpType
class	TcpTransport
class	::DDS_TEST

---

Detailed Description

Definition at line 27 of file TcpInst.h.

---

Constructor & Destructor Documentation

ACE_INLINE OpenDDS::DCPS::TcpInst::TcpInst

(

const OPENDDS_STRING &

name

)

[explicit, private]

Definition at line 11 of file TcpInst.inl.

References DBG_ENTRY_LVL.

  : 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_(2000)
{
  DBG_ENTRY_LVL("TcpInst", "TcpInst", 6);
}

OpenDDS::DCPS::TcpInst::~TcpInst

(

)

[private, virtual]

Definition at line 22 of file TcpInst.cpp.

References DBG_ENTRY_LVL.

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

---

Member Function Documentation

OPENDDS_STRING OpenDDS::DCPS::TcpInst::dump_to_str

(

)

[virtual]

Diagnostic aid.

Reimplemented from OpenDDS::DCPS::TransportInst.

Definition at line 70 of file TcpInst.cpp.

References 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() << std::endl;

  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;
  return OPENDDS_STRING(os.str());
}

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 84 of file TcpInst.h.

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

bool OpenDDS::DCPS::TcpInst::is_reliable

(

)

const [inline, virtual]

Does the transport as configured support RELIABLE_RELIABILITY_QOS?

Implements OpenDDS::DCPS::TransportInst.

Definition at line 79 of file TcpInst.h.

{ return true; }

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 34 of file TcpInst.cpp.

References GET_CONFIG_DOUBLE_VALUE, GET_CONFIG_STRING_VALUE, GET_CONFIG_VALUE, load, local_address(), 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 != "") {
    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)

  return 0;
}

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

Definition at line 97 of file TcpInst.h.

References OpenDDS::DCPS::to_dds_string().

  {
    local_address_str_ = host_name;
    local_address_str_ += ":" + to_dds_string(port_number);
    local_address_.set(port_number, host_name);
  }

void OpenDDS::DCPS::TcpInst::local_address

(

const char *

str

)

[inline]

Definition at line 92 of file TcpInst.h.

  {
    local_address_str_ = str;
    local_address_.set(str);
  }

ACE_INET_Addr OpenDDS::DCPS::TcpInst::local_address

(

)

const [inline]

Definition at line 91 of file TcpInst.h.

Referenced by OpenDDS::DCPS::TcpTransport::configure_i(), and load().

{ return local_address_; }

void OpenDDS::DCPS::TcpInst::local_address_set_port

(

u_short

port_number

)

[inline]

Definition at line 103 of file TcpInst.h.

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

                                                   {
    local_address_.set_port_number(port_number);
    size_t pos = local_address_str_.find_last_of(":");
    OPENDDS_STRING host_name = local_address_str_.substr(0, pos);
    local_address_str_ = host_name + ":" + to_dds_string(port_number);
  }

OPENDDS_STRING OpenDDS::DCPS::TcpInst::local_address_string

(

)

const [inline]

Definition at line 90 of file TcpInst.h.

Referenced by dump_to_str().

{ return local_address_str_; }

OpenDDS::DCPS::TcpTransport * OpenDDS::DCPS::TcpInst::new_impl

(

const TransportInst_rch &

inst

)

[private]

Definition at line 28 of file TcpInst.cpp.

References TcpTransport.

{
  return new TcpTransport(inst);
}

size_t OpenDDS::DCPS::TcpInst::populate_locator

(

OpenDDS::DCPS::TransportLocator &

trans_info

)

const [virtual]

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

Implements OpenDDS::DCPS::TransportInst.

Definition at line 87 of file TcpInst.cpp.

References OpenDDS::DCPS::TransportLocator::data, pub_address_str_, and OpenDDS::DCPS::TransportLocator::transport_type.

{
  if (this->local_address() != ACE_INET_Addr() || !pub_address_str_.empty()) {
    // Get the public address string from the inst (usually the local address)
    NetworkAddress network_order_address(this->get_public_address());

    ACE_OutputCDR cdr;
    cdr << network_order_address;
    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

friend class ::DDS_TEST [friend]

Definition at line 113 of file TcpInst.h.

friend class TcpTransport [friend]

Definition at line 112 of file TcpInst.h.

Referenced by new_impl().

friend class TcpType [friend]

Definition at line 111 of file TcpInst.h.

---

Member Data Documentation

int OpenDDS::DCPS::TcpInst::conn_retry_attempts_

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

Definition at line 62 of file TcpInst.h.

Referenced by dump_to_str().

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 57 of file TcpInst.h.

Referenced by dump_to_str().

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 47 of file TcpInst.h.

Referenced by dump_to_str().

bool OpenDDS::DCPS::TcpInst::enable_nagle_algorithm_

Definition at line 41 of file TcpInst.h.

Referenced by dump_to_str(), and OpenDDS::DCPS::TcpConnection::set_sock_options().

ACE_INET_Addr OpenDDS::DCPS::TcpInst::local_address_ [private]

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

Definition at line 121 of file TcpInst.h.

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 127 of file TcpInst.h.

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 69 of file TcpInst.h.

Referenced by dump_to_str().

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 77 of file TcpInst.h.

Referenced by dump_to_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 39 of file TcpInst.h.

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

---

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

• TcpInst.h
• TcpInst.cpp
• TcpInst.inl

---