Function rcl_action_goal_handle_is_active

Defined in File goal_handle.h

Function Documentation

bool rcl_action_goal_handle_is_active(const rcl_action_goal_handle_t *goal_handle)

Check if a goal is active using a rcl_action_goal_handle_t.

This is a non-blocking call.

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

Parameters:: goal_handle – [in] struct containing the goal and metadata
Returns:: true if the goal is in one of the following states: ACCEPTED, EXECUTING, or CANCELING, or
Returns:: false if the goal handle pointer is invalid, or
Returns:: false otherwise