Function rcl_lifecycle_state_fini

• Defined in File rcl_lifecycle.h

Function Documentation

rcl_ret_t rcl_lifecycle_state_fini(rcl_lifecycle_state_t *state, const rcl_allocator_t *allocator)

Finalize a rcl_lifecycle_state_t.

Calling this will set the rcl_lifecycle_state_t struct into the an unitialized state that is functionally the same as before rcl_lifecycle_state_init was called. This function make the rcl_lifecycle_state_t invalid.

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

Parameters:

• state – [inout] struct to be finalized

• allocator – [in] a valid allocator used to finalize the lifecycle state

Returns:

RCL_RET_OK if the state was finalized successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid.