Function rmw_qos_policy_kind_from_str

Function Documentation

rmw_qos_policy_kind_t rmw_qos_policy_kind_from_str(const char *str)

Return a policy kind based on the provided string.

Returns the policy kind represented by the provided string, or RMW_QOS_POLICY_INVALID when the provided string doesn’t represent any policy kind.

How policy kinds are stringified is explained in rmw_qos_policy_kind_to_str.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

No

Lock-Free

Yes

Parameters:

str[in] string identifying a qos policy kind.

Returns:

the policy kind represented by the string, or

Returns:

RMW_QOS_POLICY_INVALID if the string doesn’t represent any policy kind.