Class WireProtocolConfigQos

Inheritance Relationships

Base Type

Class Documentation

class WireProtocolConfigQos : public eprosima::fastdds::dds::QosPolicy

Qos Policy that configures the wire protocol.

Public Functions

inline FASTDDS_EXPORTED_API WireProtocolConfigQos()

Constructor.

virtual FASTDDS_EXPORTED_API ~WireProtocolConfigQos() = default

Destructor.

inline bool operator==(const WireProtocolConfigQos &b) const
inline virtual void clear() override

Clears the QosPolicy object.

inline ReturnCode_t easy_mode(const std::string &ip)

Setter for ROS 2 Easy Mode IP.

Note

The IP address must be an IPv4 address. If it is not, the IP address will not be set.

Parameters:

ip – IP address to set

Returns:

RETCODE_OK if the IP address is set, an specific error code otherwise: RETCODE_BAD_PARAMETER if the IP address is not an IPv4 address.

inline const std::string &easy_mode() const

Getter for ROS 2 Easy Mode IP.

Returns:

IP address if set, empty string otherwise

Public Members

fastdds::rtps::GuidPrefix_t prefix

Optionally allows user to define the GuidPrefix_t.

int32_t participant_id

Participant ID

By default, -1.

fastdds::rtps::BuiltinAttributes builtin

Builtin parameters.

fastdds::rtps::PortParameters port

Port Parameters.

rtps::LocatorList default_unicast_locator_list

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.

rtps::LocatorList default_multicast_locator_list

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

rtps::ExternalLocators default_external_unicast_locators

The collection of external locators to use for communication on user created topics.

bool ignore_non_matching_locators = false

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