Function rmw_topic_endpoint_info_set_endpoint_type

• Defined in File topic_endpoint_info.h

Function Documentation

rmw_ret_t rmw_topic_endpoint_info_set_endpoint_type(rmw_topic_endpoint_info_t *topic_endpoint_info, rmw_endpoint_type_t type)

Set the endpoint type in the given topic endpoint info data structure.

This functions assigns the value of the type argument to the data structure endpoint_type 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 topic endpoint info data structure is not synchronized. It is not safe to read or write the endpoint_type member of the given topic_endpoint while setting it.

Parameters:

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

• type – [in] Endpoint type to be set.

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_INVALID_ARGUMENT if topic_endpoint_info is NULL, or

Returns:

RMW_RET_ERROR when an unspecified error occurs.