Function rcl_node_get_type_description_service

Function Documentation

rcl_ret_t rcl_node_get_type_description_service(const rcl_node_t *node, rcl_service_t **service_out)

Returns a pointer to the node’s ~/get_type_description service.

On success, sets service_out to the initialized service. rcl_node_type_description_service_init must be called before this.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

  • node – [in] the handle to the node

  • service_out – [out] Handle to pointer that will be set

Returns:

RCL_RET_OK if valid service was returned successfully, or

Returns:

RCL_RET_NODE_INVALID if node is invalid, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_NOT_INIT if the service hasn’t yet been initialized, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.