Function rmw_topic_endpoint_info_set_qos_profile

Function Documentation

rmw_ret_t rmw_topic_endpoint_info_set_qos_profile(rmw_topic_endpoint_info_t *topic_endpoint_info, const rmw_qos_profile_t *qos_profile)

Set the endpoint QoS profile in the given topic endpoint info data structure.

Assigns the value of the qos_profile argument to the data structure’s qos_profile member.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Remark

This function sets the RMW error state on failure.

Thread-safety

Setting a member is a reentrant procedure, but access to the topic endpoint info data structure is not synchronized. It is not safe to read or write the qos_profile member of the given topic_endpoint while setting it.

Parameters:

  • topic_endpoint_info – [inout] Data structure to be populated.

  • qos_profile – [in] QoS profile to be set.

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_INVALID_ARGUMENT if topic_endpoint_info is NULL, or

Returns:

RMW_RET_INVALID_ARGUMENT if qos_profile is NULL, or

Returns:

RMW_RET_ERROR when an unspecified error occurs.