Function rcl_shutdown

Function Documentation

rcl_ret_t rcl_shutdown(rcl_context_t *context)

Shutdown a given rcl context.

The given context must have been initialized with rcl_init(). If not, this function will fail with RCL_RET_ALREADY_SHUTDOWN.

When this function is called:

  • Any rcl objects created using this context are invalidated.

  • Functions called on invalid objects may or may not fail.

  • Calls to rcl_context_is_initialized() will return false.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

Yes

Uses Atomics

Yes

Lock-Free

Yes [1]

[1] if returns true for

Parameters:

context – [inout] object to shutdown

Returns:

RCL_RET_OK if the shutdown was completed successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_ALREADY_SHUTDOWN if the context is not currently valid, or

Returns:

RCL_RET_ERROR if an unspecified error occur.