Base class for the descriptors of chaining transports. More...

#include <ChainingTransportDescriptor.hpp>

Inheritance diagram for ChainingTransportDescriptor:

Public Member Functions
FASTDDS_EXPORTED_API	ChainingTransportDescriptor (std::shared_ptr< TransportDescriptorInterface > low_level)

FASTDDS_EXPORTED_API	ChainingTransportDescriptor (const ChainingTransportDescriptor &t)

virtual FASTDDS_EXPORTED_API uint32_t	min_send_buffer_size () const override
	Returns the minimum size required for a send operation. More...

virtual FASTDDS_EXPORTED_API uint32_t	max_message_size () const override
	Returns the maximum size expected for received messages. More...

virtual FASTDDS_EXPORTED_API	~ChainingTransportDescriptor ()=default

Public Member Functions inherited from TransportDescriptorInterface
FASTDDS_EXPORTED_API	TransportDescriptorInterface (uint32_t maximumMessageSize, uint32_t maximumInitialPeersRange)
	Constructor. More...

FASTDDS_EXPORTED_API	TransportDescriptorInterface (const TransportDescriptorInterface &t)
	Copy constructor. More...

FASTDDS_EXPORTED_API TransportDescriptorInterface &	operator= (const TransportDescriptorInterface &t)
	Copy assignment. More...

virtual FASTDDS_EXPORTED_API	~TransportDescriptorInterface ()=default
	Destructor. More...

virtual FASTDDS_EXPORTED_API TransportInterface *	create_transport () const =0
	Factory method pattern. More...

virtual FASTDDS_EXPORTED_API uint32_t	min_send_buffer_size () const =0
	Returns the minimum size required for a send operation. More...

virtual FASTDDS_EXPORTED_API uint32_t	max_message_size () const
	Returns the maximum size expected for received messages. More...

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) More...

FASTDDS_EXPORTED_API bool	operator== (const TransportDescriptorInterface &t) const
	Comparison operator. More...

FASTDDS_EXPORTED_API void	lock ()
	Lock internal mutex (for Fast-DDS internal use) More...

FASTDDS_EXPORTED_API void	unlock ()
	Unlock internal mutex (for Fast-DDS internal use) More...

Public Attributes
std::shared_ptr< TransportDescriptorInterface >	low_level_descriptor
	Descriptor for lower level transport. More...

Public Attributes inherited from TransportDescriptorInterface
uint32_t	maxMessageSize
	Maximum size of a single message in the transport. More...

uint32_t	maxInitialPeersRange
	Number of channels opened with each initial remote peer. More...

Detailed Description

Base class for the descriptors of chaining transports.

A chaining transport allows for the manipulation of data before sending or after receiving from another transport.

Transport configuration:

low_level_descriptor: Descriptor for lower level transport.

Constructor & Destructor Documentation

◆ ChainingTransportDescriptor() [1/2]

FASTDDS_EXPORTED_API ChainingTransportDescriptor ( std::shared_ptr< TransportDescriptorInterface > low_level )

inline

◆ ChainingTransportDescriptor() [2/2]

FASTDDS_EXPORTED_API ChainingTransportDescriptor ( const ChainingTransportDescriptor & t )

inline

◆ ~ChainingTransportDescriptor()

virtual FASTDDS_EXPORTED_API ~ChainingTransportDescriptor ( )

virtualdefault

Member Function Documentation

◆ max_message_size()

virtual FASTDDS_EXPORTED_API uint32_t max_message_size ( ) const

inlineoverridevirtual

Returns the maximum size expected for received messages.

Reimplemented from TransportDescriptorInterface.

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

Member Data Documentation

◆ low_level_descriptor

std::shared_ptr<TransportDescriptorInterface> low_level_descriptor

Descriptor for lower level transport.

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

include/fastdds/rtps/transport/ChainingTransportDescriptor.hpp

Public Member Functions

Public Attributes