Function rcl_node_type_cache_unregister_type

Defined in File node_type_cache.h

Function Documentation

rcl_ret_t rcl_node_type_cache_unregister_type(const rcl_node_t *node, const rosidl_type_hash_t *type_hash)

Unregister a message type from the node’s type cache.

This function uses the given type_hash to unregister the associated type in the node’s type cache. If the type has been registered multiple times, the type will only be removed if its registration count reaches 0.

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

Parameters:

node – [in] the handle to the node whose type cache should be finalized
type_hash – [in] type hash

Returns:

RCL_RET_OK if the type was successfully registered, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_NODE_INVALID if the given node is invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.