rmw  master
C API providing a middleware abstraction layer which is used to implement the rest of ROS.
Functions
get_network_flow_endpoints.h File Reference
#include "rmw/network_flow_endpoint_array.h"
#include "rmw/types.h"
#include "rmw/visibility_control.h"
Include dependency graph for get_network_flow_endpoints.h:

Go to the source code of this file.

Functions

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. More...
 
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. More...
 

Function Documentation

◆ rmw_publisher_get_network_flow_endpoints()

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
[in]publisherthe publisher instance to inspect
[in]allocatorallocator to be used when allocating space for network_flow_endpoint_array_t
[out]network_flow_endpoint_arraythe network flow endpoints
Returns
RMW_RET_OK if successful, or
RMW_RET_INVALID_ARGUMENT if any argument is null,
RMW_RET_BAD_ALLOC if memory allocation fails, or
RMW_RET_UNSUPPORTED if not supported, or
RMW_RET_ERROR if an unexpected error occurs.

◆ rmw_subscription_get_network_flow_endpoints()

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
[in]subscriptionthe subscription instance to inspect
[in]allocatorallocator to be used when allocating space for network_flow_endpoint_array_t
[out]network_flow_endpoint_arraythe network flow endpoints
Returns
RMW_RET_OK if successful, or
RMW_RET_INVALID_ARGUMENT if any argument is null, or
RMW_RET_BAD_ALLOC if memory allocation fails, or
RMW_RET_UNSUPPORTED if not supported, or
RMW_RET_ERROR if an unexpected error occurs.