TCPv4 Transport configuration. More...
#include <TCPv4TransportDescriptor.hpp>
Public Member Functions | |
virtual | ~TCPv4TransportDescriptor ()=default |
Destructor. | |
virtual TransportInterface * | create_transport () const override |
Factory method pattern. | |
void | set_WAN_address (fastdds::rtps::octet o1, fastdds::rtps::octet o2, fastdds::rtps::octet o3, fastdds::rtps::octet o4) |
Set the public IP address. | |
void | set_WAN_address (const std::string &in_address) |
Set the public IP address. | |
std::string | get_WAN_address () |
Get the public IP address. | |
FASTDDS_EXPORTED_API | TCPv4TransportDescriptor () |
Constructor. | |
FASTDDS_EXPORTED_API | TCPv4TransportDescriptor (const TCPv4TransportDescriptor &t) |
Copy constructor. | |
FASTDDS_EXPORTED_API TCPv4TransportDescriptor & | operator= (const TCPv4TransportDescriptor &t) |
Copy assignment. | |
FASTDDS_EXPORTED_API bool | operator== (const TCPv4TransportDescriptor &t) const |
Comparison operator. | |
![]() | |
void | add_listener_port (uint16_t port) |
Add listener port to the listening_ports list. | |
FASTDDS_EXPORTED_API | TCPTransportDescriptor () |
Constructor. | |
FASTDDS_EXPORTED_API | TCPTransportDescriptor (const TCPTransportDescriptor &t) |
Copy constructor. | |
FASTDDS_EXPORTED_API TCPTransportDescriptor & | operator= (const TCPTransportDescriptor &t) |
Copy assignment. | |
virtual | ~TCPTransportDescriptor ()=default |
Destructor. | |
FASTDDS_EXPORTED_API bool | operator== (const TCPTransportDescriptor &t) const |
Comparison operator. | |
![]() | |
FASTDDS_EXPORTED_API | SocketTransportDescriptor (uint32_t maximumMessageSize, uint32_t maximumInitialPeersRange) |
Constructor. | |
FASTDDS_EXPORTED_API | SocketTransportDescriptor (const SocketTransportDescriptor &t)=default |
Copy constructor. | |
FASTDDS_EXPORTED_API SocketTransportDescriptor & | operator= (const SocketTransportDescriptor &t)=default |
Copy assignment. | |
virtual FASTDDS_EXPORTED_API | ~SocketTransportDescriptor ()=default |
Destructor. | |
virtual FASTDDS_EXPORTED_API uint32_t | min_send_buffer_size () const override |
Returns the minimum size required for a send operation. | |
bool FASTDDS_EXPORTED_API | operator== (const SocketTransportDescriptor &t) const |
Comparison operator. | |
![]() | |
FASTDDS_EXPORTED_API | PortBasedTransportDescriptor (uint32_t maximumMessageSize, uint32_t maximumInitialPeersRange) |
Constructor. | |
FASTDDS_EXPORTED_API | PortBasedTransportDescriptor (const PortBasedTransportDescriptor &t)=default |
Copy constructor. | |
FASTDDS_EXPORTED_API PortBasedTransportDescriptor & | operator= (const PortBasedTransportDescriptor &t)=default |
Copy assignment. | |
virtual FASTDDS_EXPORTED_API | ~PortBasedTransportDescriptor ()=default |
Destructor. | |
bool FASTDDS_EXPORTED_API | operator== (const PortBasedTransportDescriptor &t) const |
Comparison operator. | |
virtual FASTDDS_EXPORTED_API const ThreadSettings & | get_thread_config_for_port (uint32_t port) const |
Get the ThreadSettings for a specific port. | |
virtual FASTDDS_EXPORTED_API bool | set_thread_config_for_port (const uint32_t &port, const ThreadSettings &thread_settings) |
FASTDDS_EXPORTED_API const ThreadSettings & | default_reception_threads () const |
Returns the ThreadSettings for the default reception threads. | |
virtual FASTDDS_EXPORTED_API void | default_reception_threads (const ThreadSettings &default_reception_threads) |
Set the ThreadSettings for the default reception threads. | |
FASTDDS_EXPORTED_API const ReceptionThreadsConfigMap & | reception_threads () const |
Returns the ThreadSettings for the user-configured reception threads. | |
virtual FASTDDS_EXPORTED_API bool | reception_threads (const ReceptionThreadsConfigMap &reception_threads) |
Set the ThreadSettings for the user-configured reception threads. | |
![]() | |
FASTDDS_EXPORTED_API | TransportDescriptorInterface (uint32_t maximumMessageSize, uint32_t maximumInitialPeersRange) |
Constructor. | |
FASTDDS_EXPORTED_API | TransportDescriptorInterface (const TransportDescriptorInterface &t) |
Copy constructor. | |
FASTDDS_EXPORTED_API TransportDescriptorInterface & | operator= (const TransportDescriptorInterface &t) |
Copy assignment. | |
virtual FASTDDS_EXPORTED_API | ~TransportDescriptorInterface ()=default |
Destructor. | |
virtual FASTDDS_EXPORTED_API uint32_t | max_message_size () const |
Returns the maximum size expected for received messages. | |
virtual FASTDDS_EXPORTED_API uint32_t | max_initial_peers_range () const |
Returns the maximum number of opened channels for each initial remote peer (maximum number of guessed initial peers to try to connect) | |
FASTDDS_EXPORTED_API bool | operator== (const TransportDescriptorInterface &t) const |
Comparison operator. | |
FASTDDS_EXPORTED_API void | lock () |
Lock internal mutex (for Fast-DDS internal use) | |
FASTDDS_EXPORTED_API void | unlock () |
Unlock internal mutex (for Fast-DDS internal use) | |
Public Attributes | |
fastdds::rtps::octet | wan_addr [4] |
Public IP address. | |
![]() | |
std::vector< uint16_t > | listening_ports |
List of ports to listen as server. | |
uint32_t | keep_alive_frequency_ms |
Frequency of RTCP keep alive requests (ms) | |
uint32_t | keep_alive_timeout_ms |
Time since sending the last keep alive request to consider a connection as broken (ms) | |
uint16_t | max_logical_port |
Maximum number of logical ports to try during RTCP negotiation. | |
uint16_t | logical_port_range |
Maximum number of logical ports per request to try during RTCP negotiation. | |
uint16_t | logical_port_increment |
Increment between logical ports to try during RTCP negotiation. | |
uint32_t | tcp_negotiation_timeout |
Time to wait for logical port negotiation (ms). | |
bool | enable_tcp_nodelay |
Enables the TCP_NODELAY socket option. | |
bool | calculate_crc |
Enables the calculation and sending of CRC on message headers. | |
bool | check_crc |
Enables checking the CRC of incoming message headers. | |
bool | apply_security |
Enables the use of TLS (Transport Layer Security) | |
TLSConfig | tls_config |
Configuration of the TLS (Transport Layer Security) | |
ThreadSettings | keep_alive_thread |
Thread settings for keep alive thread. | |
ThreadSettings | accept_thread |
Thread settings for the accept connections thread. | |
bool | non_blocking_send |
Whether to use non-blocking calls to send(). | |
![]() | |
uint32_t | sendBufferSize |
Length of the send buffer. | |
uint32_t | receiveBufferSize |
Length of the receive buffer. | |
std::vector< std::string > | interfaceWhiteList |
Allowed interfaces in an IP or device name string format. | |
NetmaskFilterKind | netmask_filter |
Transport's netmask filter configuration. | |
std::vector< AllowedNetworkInterface > | interface_allowlist |
Allowed interfaces in an IP or device name string format, each with a specific netmask filter configuration. | |
std::vector< BlockedNetworkInterface > | interface_blocklist |
Blocked interfaces in an IP or device name string format. | |
uint8_t | TTL |
Specified time to live (8bit - 255 max TTL) | |
![]() | |
uint32_t | maxMessageSize |
Maximum size of a single message in the transport. | |
uint32_t | maxInitialPeersRange |
Number of channels opened with each initial remote peer. | |
Additional Inherited Members | |
![]() | |
using | ReceptionThreadsConfigMap = std::map< uint32_t, ThreadSettings > |
![]() | |
ThreadSettings | default_reception_threads_ |
Thread settings for the default reception threads. | |
ReceptionThreadsConfigMap | reception_threads_ |
Thread settings for the specific reception threads, indexed by port. | |
TCPv4 Transport configuration.
The kind value for TCPv4TransportDescriptor is given by eprosima::fastdds::rtps::LOCATOR_KIND_TCPv4
.
wan_addr:
Public IP address. Peers on a different LAN will use this IP for communications with this host.
|
virtualdefault |
Destructor.
FASTDDS_EXPORTED_API TCPv4TransportDescriptor | ( | ) |
Constructor.
FASTDDS_EXPORTED_API TCPv4TransportDescriptor | ( | const TCPv4TransportDescriptor & | t | ) |
Copy constructor.
|
overridevirtual |
Factory method pattern.
It will create and return a TransportInterface corresponding to this descriptor. This provides an interface to the NetworkFactory to create the transports without the need to know about their type
Implements TransportDescriptorInterface.
|
inline |
Get the public IP address.
FASTDDS_EXPORTED_API TCPv4TransportDescriptor & operator= | ( | const TCPv4TransportDescriptor & | t | ) |
Copy assignment.
FASTDDS_EXPORTED_API bool operator== | ( | const TCPv4TransportDescriptor & | t | ) | const |
Comparison operator.
|
inline |
Set the public IP address.
|
inline |
Set the public IP address.
fastdds::rtps::octet wan_addr[4] |
Public IP address.