Function rmw_service_endpoint_info_array_check_zero

• Defined in File service_endpoint_info_array.h

Function Documentation

rmw_ret_t rmw_service_endpoint_info_array_check_zero(rmw_service_endpoint_info_array_t *service_endpoint_info_array)

Check that the given service_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 service endpoint information is read-only, but it is not synchronized. Concurrent service_endpoint_info_array reads are safe, but concurrent reads and writes are not.

Parameters:

service_endpoint_info_array – [in] Array to be checked.

Returns:

RMW_RET_OK if array is zero initialized, or

Returns:

RMW_RET_INVALID_ARGUMENT if service_endpoint_info_array is NULL, or

Returns:

RMW_RET_ERROR if service_endpoint_info_array is not zero initialized.