Function rmw_qos_durability_policy_to_str

Defined in File qos_string_conversions.h

Function Documentation

const char *rmw_qos_durability_policy_to_str(rmw_qos_durability_policy_t value)

Return a string representing the policy value.

Returns NULL when value is RMW_QOS_POLICY_*_UNKNOWN or an undefined enum value.

The stringified version of the policy value can be obtained doing the follwing conversion: RMW_QOS_POLICY_<POLICY_KIND>_<POLICY_VALUE> -> lower_case(<POLICY_VALUE>)

For example, the stringified version of RMW_QOS_POLICY_LIVELINESS_MANUAL_BY_TOPIC is “manual_by_topic” and RMW_QOS_POLICY_RELIABILITY_BEST_EFFORT is “best_effort”.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	Yes
Uses Atomics	No
Lock-Free	Yes

Parameters:: value – [in] qos policy value to be stringified.
Returns:: a null terminated string representing the policy value, or
Returns:: NULL if value is RMW_QOS_POLICY_*_UNKNOWN or an undefined enum value.