Fast RTPS  Version 2.14.1
Fast RTPS
Loading...
Searching...
No Matches

Class PublisherAttributes, used by the user to define the attributes of a Publisher. More...

#include <PublisherAttributes.h>

Public Member Functions

 PublisherAttributes ()=default
 
virtual ~PublisherAttributes ()=default
 
bool operator== (const PublisherAttributes &b) const
 
int16_t getUserDefinedID () const
 Get the user defined ID.
 
int16_t getEntityID () const
 Get the entity defined ID.
 
void setUserDefinedID (uint8_t id)
 Set the user defined ID.
 
void setEntityID (uint8_t id)
 Set the entity ID.
 

Public Attributes

TopicAttributes topic
 Topic Attributes for the Publisher.
 
WriterQos qos
 QOS for the Publisher.
 
rtps::WriterTimes times
 Writer Attributes.
 
rtps::LocatorList_t unicastLocatorList
 Unicast locator list.
 
rtps::LocatorList_t multicastLocatorList
 Multicast locator list.
 
rtps::LocatorList_t remoteLocatorList
 Remote locator list.
 
fastdds::rtps::ExternalLocators external_unicast_locators
 The collection of external locators to use for communication.
 
bool ignore_non_matching_locators = false
 Whether locators that don't match with the announced locators should be kept.
 
rtps::ThroughputControllerDescriptor throughputController
 Throughput controller.
 
rtps::MemoryManagementPolicy_t historyMemoryPolicy
 Underlying History memory policy.
 
rtps::PropertyPolicy properties
 Properties.
 
ResourceLimitedContainerConfig matched_subscriber_allocation
 Allocation limits on the matched subscribers collections.
 

Detailed Description

Class PublisherAttributes, used by the user to define the attributes of a Publisher.

Constructor & Destructor Documentation

◆ PublisherAttributes()

PublisherAttributes ( )
default

◆ ~PublisherAttributes()

virtual ~PublisherAttributes ( )
virtualdefault

Member Function Documentation

◆ getEntityID()

int16_t getEntityID ( ) const
inline

Get the entity defined ID.

Returns
Entity ID

◆ getUserDefinedID()

int16_t getUserDefinedID ( ) const
inline

Get the user defined ID.

Returns
User defined ID

◆ operator==()

bool operator== ( const PublisherAttributes b) const
inline

◆ setEntityID()

void setEntityID ( uint8_t  id)
inline

Set the entity ID.

Parameters
idEntity ID to be set

◆ setUserDefinedID()

void setUserDefinedID ( uint8_t  id)
inline

Set the user defined ID.

Parameters
idUser defined ID to be set

Member Data Documentation

◆ external_unicast_locators

fastdds::rtps::ExternalLocators external_unicast_locators

The collection of external locators to use for communication.

◆ historyMemoryPolicy

rtps::MemoryManagementPolicy_t historyMemoryPolicy
Initial value:
=
rtps::MemoryManagementPolicy_t::PREALLOCATED_WITH_REALLOC_MEMORY_MODE

Underlying History memory policy.

◆ ignore_non_matching_locators

bool ignore_non_matching_locators = false

Whether locators that don't match with the announced locators should be kept.

◆ matched_subscriber_allocation

ResourceLimitedContainerConfig matched_subscriber_allocation

Allocation limits on the matched subscribers collections.

◆ multicastLocatorList

rtps::LocatorList_t multicastLocatorList

Multicast locator list.

◆ properties

rtps::PropertyPolicy properties

Properties.

◆ qos

WriterQos qos

QOS for the Publisher.

◆ remoteLocatorList

rtps::LocatorList_t remoteLocatorList

Remote locator list.

◆ throughputController

rtps::ThroughputControllerDescriptor throughputController

Throughput controller.

◆ times

rtps::WriterTimes times

Writer Attributes.

◆ topic

Topic Attributes for the Publisher.

◆ unicastLocatorList

rtps::LocatorList_t unicastLocatorList

Unicast locator list.


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