Function rcl_action_goal_handle_is_cancelable

Function Documentation

bool rcl_action_goal_handle_is_cancelable(const rcl_action_goal_handle_t *goal_handle)

Check if a goal can be transitioned to CANCELING in its current state.

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 can be transitioned to CANCELING from its current state, or

Returns:

false if the goal handle pointer is invalid, or

Returns:

false otherwise