#include <UdpInst.h>

Inheritance diagram for OpenDDS::DCPS::UdpInst:

Collaboration diagram for OpenDDS::DCPS::UdpInst:

[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...

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
ACE_INT32	send_buffer_size_

ACE_INT32	rcv_buffer_size_

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_

Private Member Functions
	UdpInst (const std::string &name)

TransportImpl_rch	new_impl ()

Private Attributes
ACE_INET_Addr	local_address_

OPENDDS_STRING	local_address_config_str_

Friends
class	UdpType

class	UdpDataLink

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)

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

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 23 of file UdpInst.h.

Constructor & Destructor Documentation

◆ UdpInst()

OpenDDS::DCPS::UdpInst::UdpInst ( const std::string & name )

explicitprivate

Definition at line 25 of file UdpInst.cpp.

References ACE_DEFAULT_MAX_SOCKET_BUFSIZ, and if().

   : TransportInst("udp", name),
 #if defined (ACE_DEFAULT_MAX_SOCKET_BUFSIZ)
     send_buffer_size_(ACE_DEFAULT_MAX_SOCKET_BUFSIZ),
     rcv_buffer_size_(ACE_DEFAULT_MAX_SOCKET_BUFSIZ)
 #else
     send_buffer_size_(0),
     rcv_buffer_size_(0)
 #endif
 {
 }

Member Function Documentation

◆ dump_to_str()

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

virtual

Diagnostic aid.

Reimplemented from OpenDDS::DCPS::TransportInst.

Definition at line 66 of file UdpInst.cpp.

References OpenDDS::DCPS::TransportInst::dump_to_str(), OpenDDS::DCPS::TransportInst::formatNameForDump(), local_address(), OPENDDS_STRING, rcv_buffer_size_, send_buffer_size_, and OpenDDS::DCPS::LogAddr::str().

 {
   std::ostringstream os;
   os << TransportInst::dump_to_str();
 
   os << formatNameForDump("local_address") << LogAddr(local_address()).str() << std::endl;
   os << formatNameForDump("send_buffer_size") << this->send_buffer_size_ << std::endl;
   os << formatNameForDump("rcv_buffer_size") << this->rcv_buffer_size_ << std::endl;
   return OPENDDS_STRING(os.str());
 }

◆ is_reliable()

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

inlinevirtual

Does the transport as configured support RELIABLE_RELIABILITY_QOS?

Implements OpenDDS::DCPS::TransportInst.

Definition at line 34 of file UdpInst.h.

34 { return false; }

◆ load()

int OpenDDS::DCPS::UdpInst::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 44 of file UdpInst.cpp.

References ACE_TEXT(), ACE_TEXT_ALWAYS_CHAR, ACE_String_Base< char >::c_str(), ACE_String_Base< char >::empty(), GET_CONFIG_TSTRING_VALUE, GET_CONFIG_VALUE, OpenDDS::DCPS::TransportInst::load(), local_address(), OPENDDS_STRING, rcv_buffer_size_, and send_buffer_size_.

 {
   TransportInst::load(cf, sect); // delegate to parent
 
   // Explicitly initialize this string to stop gcc 11 from issuing a warning.
   ACE_TString local_address_s(ACE_TEXT(""));
   GET_CONFIG_TSTRING_VALUE(cf, sect, ACE_TEXT("local_address"),
                            local_address_s);
 
   if (!local_address_s.empty()) {
     local_address(ACE_TEXT_ALWAYS_CHAR(local_address_s.c_str()));
   }
 
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("send_buffer_size"), this->send_buffer_size_, ACE_UINT32);
 
   GET_CONFIG_VALUE(cf, sect, ACE_TEXT("rcv_buffer_size"), this->rcv_buffer_size_, ACE_UINT32);
 
   return 0;
 }

◆ local_address() [1/4]

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

inline

Definition at line 39 of file UdpInst.h.

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

39 { return local_address_; }

OpenDDS::DCPS::UdpInst::local_address_

ACE_INET_Addr local_address_

Definition: UdpInst.h:72

◆ local_address() [2/4]

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

inline

Definition at line 40 of file UdpInst.h.

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

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

◆ local_address() [3/4]

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

inline

Definition at line 45 of file UdpInst.h.

References OpenDDS::DCPS::choose_single_coherent_address().

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

◆ local_address() [4/4]

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

inline

Definition at line 50 of file UdpInst.h.

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

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

◆ local_address_set_port()

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

inline

Definition at line 56 of file UdpInst.h.

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

◆ local_address_string()

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

inline

Definition at line 38 of file UdpInst.h.

Referenced by populate_locator().

38 { return local_address_config_str_; }

OpenDDS::DCPS::UdpInst::local_address_config_str_

OPENDDS_STRING local_address_config_str_

Definition: UdpInst.h:73

◆ new_impl()

TransportImpl_rch OpenDDS::DCPS::UdpInst::new_impl ( )

privatevirtual

Implements OpenDDS::DCPS::TransportInst.

Definition at line 38 of file UdpInst.cpp.

References OpenDDS::DCPS::rchandle_from().

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

◆ populate_locator()

size_t OpenDDS::DCPS::UdpInst::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 78 of file UdpInst.cpp.

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

 {
   if (this->local_address() != ACE_INET_Addr()) {
     NetworkResource network_resource;
     if (!this->local_address_string().empty()) {
       network_resource = NetworkResource(this->local_address_string());
     } else {
       network_resource = NetworkResource(get_fully_qualified_hostname());
     }
     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
 
     info.transport_type = "udp";
     info.data = TransportBLOB(len, len, reinterpret_cast<CORBA::Octet*>(buffer));
     return 1;
   } else {
     return 0;
   }
 }

Friends And Related Function Documentation

◆ OpenDDS::DCPS::make_rch

template<typename T , typename U >

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

friend

◆ UdpDataLink

friend class UdpDataLink

friend

Definition at line 63 of file UdpInst.h.

◆ UdpType

friend class UdpType

friend

Definition at line 62 of file UdpInst.h.

Member Data Documentation

◆ local_address_

ACE_INET_Addr OpenDDS::DCPS::UdpInst::local_address_

private

The address from which to send/receive data. The default value is: none.

Definition at line 72 of file UdpInst.h.

◆ local_address_config_str_

OPENDDS_STRING OpenDDS::DCPS::UdpInst::local_address_config_str_

private

Definition at line 73 of file UdpInst.h.

◆ rcv_buffer_size_

ACE_INT32 OpenDDS::DCPS::UdpInst::rcv_buffer_size_

Definition at line 26 of file UdpInst.h.

Referenced by dump_to_str(), and load().

◆ send_buffer_size_

ACE_INT32 OpenDDS::DCPS::UdpInst::send_buffer_size_

Definition at line 25 of file UdpInst.h.

Referenced by dump_to_str(), and load().

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

Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ UdpInst()

Member Function Documentation

◆ dump_to_str()

◆ 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

◆ OpenDDS::DCPS::make_rch

◆ UdpDataLink

◆ UdpType

Member Data Documentation

◆ local_address_

◆ local_address_config_str_

◆ rcv_buffer_size_

◆ send_buffer_size_