Function rmw_service_endpoint_info_set_service_type_hash

Function Documentation

rmw_ret_t rmw_service_endpoint_info_set_service_type_hash(rmw_service_endpoint_info_t *service_endpoint_info, const rosidl_type_hash_t *type_hash)

Set the service type hash in the given service endpoint info data structure.

Assigns the value of the service_type_hash argument to the data structure’s service_type_hash member.

Attribute

Adherence

Allocates Memory

No

Thread-Safe

No

Uses Atomics

No

Lock-Free

Yes

Remark

This function sets the RMW error state on failure.

Thread-safety

Setting a member is a reentrant procedure, but:

  • Access to the service endpoint info data structure is not synchronized. It is not safe to read or write the service_type_hash member of the given service_endpoint while setting it. Concurrent service_type_hash reads are safe, but concurrent reads and writes are not.

Parameters:

  • service_endpoint_info – [inout] Data structure to be populated.

  • type_hash – [in] Service type hash to be copied.

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_INVALID_ARGUMENT if service_endpoint_info is NULL, or

Returns:

RMW_RET_INVALID_ARGUMENT if service_type_hash is NULL, or

Returns:

RMW_RET_ERROR when an unspecified error occurs.