Function rcl_client_get_service_name

Function Documentation

const char *rcl_client_get_service_name(const rcl_client_t *client)

Get the name of the service that this client will request a response from.

This function returns the client’s internal service name string. This function can fail, and therefore return NULL, if the:

  • client is NULL

  • client is invalid (never called init, called fini, or invalid node)

The returned string is only valid as long as the rcl_client_t is valid. The value of the string may change if the service name changes, and therefore copying the string is recommended if this is a concern.

Attribute

Adherence

Allocates Memory

Yes

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Parameters:

client[in] pointer to the client

Returns:

name string if successful, otherwise NULL