Function rmw_shutdown

Function Documentation

rmw_ret_t rmw_shutdown(rmw_context_t *context)

Shutdown the middleware for a given context.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Remark

If context is zero initialized, then RMW_RET_INVALID_ARGUMENT is returned. If context has been already invalidated (rmw_shutdown() was called on it), then this function is a no-op and RMW_RET_OK is returned.

This should be defined by the rmw implementation.

Pre:

The given context must be a valid context which has been initialized with rmw_init().

Parameters:

context – [in] resulting context struct

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_INVALID_ARGUMENT if any argument are invalid, or

Returns:

RMW_RET_INCORRECT_RMW_IMPLEMENTATION if the implementation identifier does not match, or

Returns:

RMW_RET_ERROR if an unexpected error occurs.