Function rcl_action_goal_handle_is_valid

• Defined in File goal_handle.h

Function Documentation

bool rcl_action_goal_handle_is_valid(const rcl_action_goal_handle_t *goal_handle)

Check if a rcl_action_goal_handle_t is valid.

This is a non-blocking call.

A goal handle is invalid if:

• the implementation is NULL (rcl_action_goal_handle_init() not called or failed)

• rcl_shutdown() has been called since the goal handle has been initialized

• the goal handle has been finalized with rcl_action_goal_handle_fini()

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

Parameters:

goal_handle – [in] struct to evaluate as valid or not

Returns:

true if the goal handle is valid, or

Returns:

false if the goal handle pointer is null, or

Returns:

false otherwise