Function rcl_client_set_on_new_response_callback

Function Documentation

rcl_ret_t rcl_client_set_on_new_response_callback(const rcl_client_t *client, rcl_event_callback_t callback, const void *user_data)

Set the on new response callback function for the client.

This API sets the callback function to be called whenever the client is notified about a new response.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

Yes

Uses Atomics

Maybe [1]

Lock-Free

Maybe [1]

[1] rmw implementation defined

See also

rmw_client_set_on_new_response_callback for details about this function.

Parameters:
  • client[in] The client on which to set the callback

  • callback[in] The callback to be called when new responses arrive, may be NULL

  • user_data[in] Given to the callback when called later, may be NULL

Returns:

RCL_RET_OK if callback was set to the listener, or

Returns:

RCL_RET_INVALID_ARGUMENT if client is NULL, or

Returns:

RCL_RET_UNSUPPORTED if the API is not implemented in the dds implementation