Function rclc_executor_set_timeout

Function Documentation

rcl_ret_t rclc_executor_set_timeout(rclc_executor_t *executor, const uint64_t timeout_ns)

Set timeout in nanoseconds for rcl_wait (called during rclc_executor_spin_once()).

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:
  • executor[inout] pointer to an initialized executor

  • timeout_ns[in] timeout in nanoseconds for the rcl_wait (DDS middleware)

Returns:

RCL_RET_OK if timeout was set successfully

Returns:

RCL_RET_INVALID_ARGUMENT if executor is a null pointer

Returns:

RCL_RET_ERROR in an error occured