Function rmw_subscription_get_network_flow_endpoints

• Defined in File get_network_flow_endpoints.h

Function Documentation

rmw_ret_t rmw_subscription_get_network_flow_endpoints(const rmw_subscription_t *subscription, rcutils_allocator_t *allocator, rmw_network_flow_endpoint_array_t *network_flow_endpoint_array)

Get network flow endpoints of a subscription.

Query the underlying middleware for a given subscription’s network flow endpoints

Parameters:

• subscription – [in] the subscription instance to inspect

• allocator – [in] allocator to be used when allocating space for network_flow_endpoint_array_t

• network_flow_endpoint_array – [out] the network flow endpoints

Returns:

RMW_RET_OK if successful, or

Returns:

RMW_RET_INVALID_ARGUMENT if any argument is null, or

Returns:

RMW_RET_BAD_ALLOC if memory allocation fails, or

Returns:

RMW_RET_UNSUPPORTED if not supported, or

Returns:

RMW_RET_ERROR if an unexpected error occurs.