Function rcl_action_client_is_valid

Function Documentation

bool rcl_action_client_is_valid(const rcl_action_client_t *action_client)

Check that a rcl_action_client_t is valid.

The bool returned is false if action_client 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:

action_client – [in] pointer to the rcl action client

Returns:

true if action_client is valid, otherwise false