Function rcl_node_type_cache_register_type

Function Documentation

rcl_ret_t rcl_node_type_cache_register_type(const rcl_node_t *node, const rosidl_type_hash_t *type_hash, const rosidl_runtime_c__type_description__TypeDescription *type_description, const rosidl_runtime_c__type_description__TypeSource__Sequence *type_description_sources)

Register a type with the node’s type cache.

This function registers the given type, uniquely identified by the type_hash, with the node with the node’s type cache. Multiple registrations of the same type will increment its registration count.

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] hash of the type

  • type_description – [in] type description struct

  • type_description_sources – [in] type description sources struct

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.