Fast DDS  Version 3.1.2
Fast DDS
Loading...
Searching...
No Matches
SocketTransportDescriptor Struct Reference

Virtual base class for the data type used to define configuration of transports using sockets. More...

#include <SocketTransportDescriptor.hpp>

Inheritance diagram for SocketTransportDescriptor:

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 SocketTransportDescriptoroperator= (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.
 
- Public Member Functions inherited from PortBasedTransportDescriptor
FASTDDS_EXPORTED_API PortBasedTransportDescriptor (uint32_t maximumMessageSize, uint32_t maximumInitialPeersRange)
 Constructor.
 
FASTDDS_EXPORTED_API PortBasedTransportDescriptor (const PortBasedTransportDescriptor &t)=default
 Copy constructor.
 
FASTDDS_EXPORTED_API PortBasedTransportDescriptoroperator= (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 ThreadSettingsget_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 ThreadSettingsdefault_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 ReceptionThreadsConfigMapreception_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.
 
- Public Member Functions inherited from TransportDescriptorInterface
FASTDDS_EXPORTED_API TransportDescriptorInterface (uint32_t maximumMessageSize, uint32_t maximumInitialPeersRange)
 Constructor.
 
FASTDDS_EXPORTED_API TransportDescriptorInterface (const TransportDescriptorInterface &t)
 Copy constructor.
 
FASTDDS_EXPORTED_API TransportDescriptorInterfaceoperator= (const TransportDescriptorInterface &t)
 Copy assignment.
 
virtual FASTDDS_EXPORTED_API ~TransportDescriptorInterface ()=default
 Destructor.
 
virtual FASTDDS_EXPORTED_API TransportInterfacecreate_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< AllowedNetworkInterfaceinterface_allowlist
 Allowed interfaces in an IP or device name string format, each with a specific netmask filter configuration.
 
std::vector< BlockedNetworkInterfaceinterface_blocklist
 Blocked interfaces in an IP or device name string format.
 
uint8_t TTL
 Specified time to live (8bit - 255 max TTL)
 
- Public Attributes inherited from TransportDescriptorInterface
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

- Public Types inherited from PortBasedTransportDescriptor
using ReceptionThreadsConfigMap = std::map<uint32_t, ThreadSettings>
 
- Protected Attributes inherited from PortBasedTransportDescriptor
ThreadSettings default_reception_threads_
 Thread settings for the default reception threads.
 
ReceptionThreadsConfigMap reception_threads_
 Thread settings for the specific reception threads, indexed by port.
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ SocketTransportDescriptor() [1/2]

FASTDDS_EXPORTED_API SocketTransportDescriptor ( uint32_t maximumMessageSize,
uint32_t maximumInitialPeersRange )
inline

Constructor.

◆ SocketTransportDescriptor() [2/2]

FASTDDS_EXPORTED_API SocketTransportDescriptor ( const SocketTransportDescriptor & t)
default

Copy constructor.

◆ ~SocketTransportDescriptor()

virtual FASTDDS_EXPORTED_API ~SocketTransportDescriptor ( )
virtualdefault

Destructor.

Member Function Documentation

◆ min_send_buffer_size()

virtual FASTDDS_EXPORTED_API uint32_t min_send_buffer_size ( ) const
inlineoverridevirtual

Returns the minimum size required for a send operation.

Implements TransportDescriptorInterface.

◆ operator=()

FASTDDS_EXPORTED_API SocketTransportDescriptor & operator= ( const SocketTransportDescriptor & t)
default

Copy assignment.

◆ operator==()

bool FASTDDS_EXPORTED_API operator== ( const SocketTransportDescriptor & t) const
inline

Comparison operator.

Member Data Documentation

◆ interface_allowlist

std::vector<AllowedNetworkInterface> interface_allowlist

Allowed interfaces in an IP or device name string format, each with a specific netmask filter configuration.

◆ interface_blocklist

std::vector<BlockedNetworkInterface> interface_blocklist

Blocked interfaces in an IP or device name string format.

◆ interfaceWhiteList

std::vector<std::string> interfaceWhiteList

Allowed interfaces in an IP or device name string format.

◆ netmask_filter

NetmaskFilterKind netmask_filter

Transport's netmask filter configuration.

◆ receiveBufferSize

uint32_t receiveBufferSize

Length of the receive buffer.

◆ sendBufferSize

uint32_t sendBufferSize

Length of the send buffer.

◆ TTL

uint8_t TTL

Specified time to live (8bit - 255 max TTL)


The documentation for this struct was generated from the following file: