18.2.1.17. RTPSParticipantAttributes

class eprosima::fastrtps::rtps::RTPSParticipantAttributes

Class RTPSParticipantAttributes used to define different aspects of a RTPSParticipant.

Public Functions

void setup_transports(fastdds::rtps::BuiltinTransports transports)

Provides a way of easily configuring transport related configuration on certain pre-defined scenarios.

Parameters

transports – Defines the transport configuration scenario to setup.

inline void setName(const char *nam)

Set the name of the participant.

inline const char *getName() const

Get the name of the participant.

Public Members

LocatorList_t defaultUnicastLocatorList

Default list of Unicast Locators to be used for any Endpoint defined inside this RTPSParticipant in the case that it was defined with NO UnicastLocators. At least ONE locator should be included in this list.

LocatorList_t defaultMulticastLocatorList

Default list of Multicast Locators to be used for any Endpoint defined inside this RTPSParticipant in the case that it was defined with NO UnicastLocators. This is usually left empty.

uint32_t sendSocketBufferSize = 0

Send socket buffer size for the send resource.

Zero value indicates to use default system buffer size. Default value: 0.

uint32_t listenSocketBufferSize = 0

Listen socket buffer for all listen resources.

Zero value indicates to use default system buffer size. Default value: 0.

GuidPrefix_t prefix

Optionally allows user to define the GuidPrefix_t.

BuiltinAttributes builtin

Builtin parameters.

PortParameters port

Port Parameters.

std::vector<octet> userData

User Data of the participant.

int32_t participantID = -1

Participant ID.

ThroughputControllerDescriptor throughputController

Throughput controller parameters. Leave default for uncontrolled flow.

Deprecated:

Use flow_controllers on RTPSParticipantAttributes

std::vector<std::shared_ptr<fastdds::rtps::TransportDescriptorInterface>> userTransports

User defined transports to use alongside or in place of builtins.

bool useBuiltinTransports = true

Set as false to disable the creation of the default transports.

RTPSParticipantAllocationAttributes allocation

Holds allocation limits affecting collections managed by a participant.

PropertyPolicy properties

Property policies.

FlowControllerDescriptorList flow_controllers

Flow controllers.