Public Attributes | List of all members
cras::priority_mux::OutputTopicConfig Struct Reference

Configuration of an output topic for the mux. More...

#include <priority_mux_base.h>

Public Attributes

::cras::optional< bool > forceLatch
 
size_t numSubscribersToWait {0u}
 
size_t queueSize
 Queue size for the publisher. More...
 
::ros::WallDuration subscriberConnectDelay
 
::std::string topic
 The output topic. More...
 

Detailed Description

Configuration of an output topic for the mux.

Definition at line 58 of file priority_mux_base.h.

Member Data Documentation

◆ forceLatch

::cras::optional<bool> cras::priority_mux::OutputTopicConfig::forceLatch

If set, forces the topic's latching status to the value. Otherwise, latching is configured based on latching of the first received message.

Definition at line 61 of file priority_mux_base.h.

◆ numSubscribersToWait

size_t cras::priority_mux::OutputTopicConfig::numSubscribersToWait {0u}

If non-zero, when the publisher is created, it will wait until it has this number of subscribers before it publishes its first message. This is more reliable than setting the delay if you know the number of subscribers. The number is not the actual number of subscriber objects, but rather the number of subscribing separate nodes (so e.g. all subscriptions from a single nodelet manager count as one).

Definition at line 65 of file priority_mux_base.h.

◆ queueSize

size_t cras::priority_mux::OutputTopicConfig::queueSize

Queue size for the publisher.

Definition at line 71 of file priority_mux_base.h.

◆ subscriberConnectDelay

::ros::WallDuration cras::priority_mux::OutputTopicConfig::subscriberConnectDelay

Time to wait before publishing the first message after the publisher is created. Only applies to non-latched topics.

Definition at line 63 of file priority_mux_base.h.

◆ topic

::std::string cras::priority_mux::OutputTopicConfig::topic

The output topic.

Definition at line 60 of file priority_mux_base.h.


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


cras_topic_tools
Author(s): Martin Pecka
autogenerated on Mon Jun 17 2024 02:49:11