Function rmw_qos_policy_kind_to_str

• Defined in File qos_string_conversions.h

Function Documentation

const char *rmw_qos_policy_kind_to_str(rmw_qos_policy_kind_t kind)

Return a string representing the policy kind.

Returns NULL when kind is RMW_QOS_POLICY_INVALID or an undefined kind.

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

For example, the stringified version of RMW_QOS_POLICY_DURABILITY is “durability” and RMW_QOS_POLICY_DEADLINE is “deadline”.

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

Parameters:

kind – [in] qos policy kind to be stringified.

Returns:

a null terminated string representing the policy kind, or

Returns:

NULL if kind is RMW_QOS_POLICY_INVALID or an undefined kind.