Function rcl_subscription_is_valid

• Defined in File subscription.h

Function Documentation

bool rcl_subscription_is_valid(const rcl_subscription_t *subscription)

Check that the subscription is valid.

The bool returned is false if subscription is invalid. The bool returned is true otherwise. In the case where false is to be returned, an error message is set. This function cannot fail.

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

Parameters:

subscription – [in] pointer to the rcl subscription

Returns:

true if subscription is valid, otherwise false