Function rcl_client_fini

Function Documentation

rcl_ret_t rcl_client_fini(rcl_client_t *client, rcl_node_t *node)

Finalize a rcl_client_t.

After calling this function, calls to rcl_send_request() and rcl_take_response() will fail when using this client. However, the given node handle is still valid.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

  • client – [inout] handle to the client to be finalized

  • node – [in] a valid (not finalized) handle to the node used to create the client

Returns:

RCL_RET_OK if client was finalized successfully, or

Returns:

RCL_RET_INVALID_ARGUMENT if any arguments are invalid, or

Returns:

RCL_RET_NODE_INVALID if the node is invalid, or

Returns:

RCL_RET_ERROR if an unspecified error occurs.