Function rmw_publisher_get_network_flow_endpoints
Defined in File get_network_flow_endpoints.h
Function Documentation
-
rmw_ret_t rmw_publisher_get_network_flow_endpoints(const rmw_publisher_t *publisher, rcutils_allocator_t *allocator, rmw_network_flow_endpoint_array_t *network_flow_endpoint_array)
Get network flow endpoints of a publisher.
Query the underlying middleware for a given publisher’s network flow endpoints
- Parameters:
publisher – [in] the publisher 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,- 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.