rmw_subscription_options_t Struct Reference

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

#include <types.h>

Public Attributes
void *	rmw_specific_subscription_payload
	Used to pass rmw implementation specific resources during subscription creation. More...
bool	ignore_local_publications
	If true then the middleware should not deliver data from local publishers. More...

Detailed Description

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

Member Data Documentation

rmw_specific_subscription_payload

void* rmw_subscription_options_t::rmw_specific_subscription_payload

Used to pass rmw implementation specific resources during subscription creation.

All the same details and restrictions of this field in rmw_publisher_options_t apply to this struct as well.

See also

rmw_publisher_options_t.rmw_specific_publisher_payload

ignore_local_publications

bool rmw_subscription_options_t::ignore_local_publications

If true then the middleware should not deliver data from local publishers.

This setting is most often used when data should only be received from remote nodes, especially to avoid "double delivery" when both intra- and inter- process communication is taking place.

\TODO(wjwwood): nail this down when participant mapping is sorted out. See: https://github.com/ros2/design/pull/250

The definition of local is somewhat vague at the moment. Right now it means local to the node, and that definition works best, but may become more complicated when/if participants map to a context instead.

---

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

• include/rmw/types.h