rclcpp  master
C++ ROS Client Library API
Classes | Public Attributes | List of all members
rclcpp::SubscriptionOptionsBase Struct Reference

Non-template base class for subscription options. More...

#include <subscription_options.hpp>

Inheritance diagram for rclcpp::SubscriptionOptionsBase:
Inheritance graph
[legend]
Collaboration diagram for rclcpp::SubscriptionOptionsBase:
Collaboration graph
[legend]

Classes

struct  TopicStatisticsOptions
 

Public Attributes

SubscriptionEventCallbacks event_callbacks
 Callbacks for events related to this subscription. More...
 
bool use_default_callbacks = true
 Whether or not to use default callbacks when user doesn't supply any in event_callbacks. More...
 
bool ignore_local_publications = false
 True to ignore local publications. More...
 
rmw_unique_network_flow_endpoints_requirement_t require_unique_network_flow_endpoints
 
rclcpp::CallbackGroup::SharedPtr callback_group = nullptr
 The callback group for this subscription. NULL to use the default callback group. More...
 
IntraProcessSetting use_intra_process_comm = IntraProcessSetting::NodeDefault
 Setting to explicitly set intraprocess communications. More...
 
IntraProcessBufferType intra_process_buffer_type = IntraProcessBufferType::CallbackDefault
 Setting the data-type stored in the intraprocess buffer. More...
 
std::shared_ptr< rclcpp::detail::RMWImplementationSpecificSubscriptionPayloadrmw_implementation_payload = nullptr
 Optional RMW implementation specific payload to be used during creation of the subscription. More...
 
TopicStatisticsOptions topic_stats_options
 
QosOverridingOptions qos_overriding_options
 

Detailed Description

Non-template base class for subscription options.

Member Data Documentation

◆ event_callbacks

SubscriptionEventCallbacks rclcpp::SubscriptionOptionsBase::event_callbacks

Callbacks for events related to this subscription.

◆ use_default_callbacks

bool rclcpp::SubscriptionOptionsBase::use_default_callbacks = true

Whether or not to use default callbacks when user doesn't supply any in event_callbacks.

◆ ignore_local_publications

bool rclcpp::SubscriptionOptionsBase::ignore_local_publications = false

True to ignore local publications.

◆ require_unique_network_flow_endpoints

rmw_unique_network_flow_endpoints_requirement_t rclcpp::SubscriptionOptionsBase::require_unique_network_flow_endpoints
Initial value:

Require middleware to generate unique network flow endpoints Disabled by default

◆ callback_group

rclcpp::CallbackGroup::SharedPtr rclcpp::SubscriptionOptionsBase::callback_group = nullptr

The callback group for this subscription. NULL to use the default callback group.

◆ use_intra_process_comm

IntraProcessSetting rclcpp::SubscriptionOptionsBase::use_intra_process_comm = IntraProcessSetting::NodeDefault

Setting to explicitly set intraprocess communications.

◆ intra_process_buffer_type

IntraProcessBufferType rclcpp::SubscriptionOptionsBase::intra_process_buffer_type = IntraProcessBufferType::CallbackDefault

Setting the data-type stored in the intraprocess buffer.

◆ rmw_implementation_payload

std::shared_ptr<rclcpp::detail::RMWImplementationSpecificSubscriptionPayload> rclcpp::SubscriptionOptionsBase::rmw_implementation_payload = nullptr

Optional RMW implementation specific payload to be used during creation of the subscription.

◆ topic_stats_options

TopicStatisticsOptions rclcpp::SubscriptionOptionsBase::topic_stats_options

◆ qos_overriding_options

QosOverridingOptions rclcpp::SubscriptionOptionsBase::qos_overriding_options

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