Function rcl_timer_is_canceled

• Defined in File timer.h

Function Documentation

rcl_ret_t rcl_timer_is_canceled(const rcl_timer_t *timer, bool *is_canceled)

Retrieve the canceled state of a timer.

If the timer is canceled true will be stored in the is_canceled argument. Otherwise false will be stored in the is_canceled argument.

The is_canceled argument must point to an allocated bool, as the result is copied into this variable.

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

[1] if returns true for

Parameters:

• timer – [in] the timer to be queried

• is_canceled – [out] storage for the is canceled bool

Returns:

RCL_RET_OK if the last call time was retrieved successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_TIMER_INVALID if the timer->impl is invalid, or

Returns:

RCL_RET_ERROR an unspecified error occur.