rmw_publisher_options_t Struct Reference

Options that can be used to configure the creation of a publisher in rmw. More...

#include <types.h>

Public Attributes
void *	rmw_specific_publisher_payload
	Used to pass rmw implementation specific resources during publisher creation. More...
rmw_unique_network_flow_endpoints_requirement_t	require_unique_network_flow_endpoints
	Require middleware to generate unique network flow endpoints. More...

Detailed Description

Options that can be used to configure the creation of a publisher in rmw.

Member Data Documentation

rmw_specific_publisher_payload

void* rmw_publisher_options_t::rmw_specific_publisher_payload

Used to pass rmw implementation specific resources during publisher creation.

This field is type erased (rather than forward declared) because it will usually be a non-owned reference to an language specific object, e.g. C++ it may be a polymorphic class that only the rmw implementation can use.

The resource pointed to here needs to outlive this options structure, and any rmw_publisher objects that are created using it, as they copy this structure and may use this payload throughout their lifetime.

require_unique_network_flow_endpoints

rmw_unique_network_flow_endpoints_requirement_t rmw_publisher_options_t::require_unique_network_flow_endpoints

Require middleware to generate unique network flow endpoints.

Unique network flow endpoints are required to differentiate the QoS provided by networks for flows between publishers and subscribers in communicating nodes. Default value is RMW_UNIQUE_NETWORK_FLOW_ENDPOINTS_NOT_REQUIRED.

---

The documentation for this struct was generated from the following file:

• include/rmw/types.h