Virtual base class for the data type used to define configuration of transports using sockets. More...
#include <SocketTransportDescriptor.hpp>
Public Member Functions | |
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 TransportInterface * | create_transport () const =0 |
Factory method pattern. | |
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 | |
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. | |
Virtual base class for the data type used to define configuration of transports using sockets.
sendBufferSize:
size of the sending buffer of the socket (in octets).receiveBufferSize:
size of the receiving buffer of the socket (in octets).interfaceWhiteList:
list of allowed interfaces.TTL:
time to live, in number of hops.
|
inline |
Constructor.
|
default |
Copy constructor.
|
virtualdefault |
Destructor.
|
inlineoverridevirtual |
Returns the minimum size required for a send operation.
Implements TransportDescriptorInterface.
|
default |
Copy assignment.
|
inline |
Comparison operator.
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.
std::vector<std::string> interfaceWhiteList |
Allowed interfaces in an IP or device name string format.
NetmaskFilterKind netmask_filter |
Transport's netmask filter configuration.
uint32_t receiveBufferSize |
Length of the receive buffer.
uint32_t sendBufferSize |
Length of the send buffer.
uint8_t TTL |
Specified time to live (8bit - 255 max TTL)