Function rmw_topic_endpoint_info_array_check_zero

• Defined in File topic_endpoint_info_array.h

Function Documentation

rmw_ret_t rmw_topic_endpoint_info_array_check_zero(rmw_topic_endpoint_info_array_t *topic_endpoint_info_array)

Check that the given topic_endpoint_info_array is zero initialized.

Attribute	Adherence
Allocates Memory	No
Thread-Safe	Yes
Uses Atomics	No
Lock-Free	Yes

Remark

This function sets the RMW error state on failure.

Thread-safety

Access to the array of topic endpoint information is read-only, but it is not synchronized. Concurrent topic_endpoint_info_array reads are safe, but concurrent reads and writes are not.

Parameters:

topic_endpoint_info_array – [in] Array to be checked.

Returns:

RMW_RET_OK if array is zero initialized, or

Returns:

RMW_RET_INVALID_ARGUMENT if topic_endpoint_info_array is NULL, or

Returns:

RMW_RET_ERROR if topic_endpoint_info_array is not zero initialized.