Goby3 3.4.0
2026.04.13
Loading...
Searching...
No Matches
goby::middleware::tool Namespace Reference

Functions

template<typename InterprocessType , typename PublishConfig >
void publish_tool_impl (InterprocessType &interprocess, const PublishConfig &cfg, const std::string &tool_name)
 Publish a single message on the interprocess layer using the provided publish config.
 
template<typename InterprocessType , typename SubscribeConfig >
void subscribe_tool_impl (InterprocessType &interprocess, const SubscribeConfig &cfg, std::map< int, std::unique_ptr< goby::middleware::log::LogPlugin > > &plugins, const std::string &internal_group_regex="")
 Set up subscriptions for the interprocess subscribe tool.
 

Function Documentation

◆ publish_tool_impl()

template<typename InterprocessType , typename PublishConfig >
void goby::middleware::tool::publish_tool_impl ( InterprocessType &  interprocess,
const PublishConfig &  cfg,
const std::string &  tool_name 
)

Publish a single message on the interprocess layer using the provided publish config.

Template Parameters
InterprocessTypeTransport-specific interprocess portal type
PublishConfigConfig type with group(), type(), value(), and load_shared_library() accessors (e.g. goby::middleware::protobuf::PublishToolConfig or a superset)
Parameters
interprocessReference to the interprocess portal
cfgPublish configuration
tool_nameName of the tool for error messages (e.g. "goby zeromq publish")

Definition at line 66 of file publish_subscribe_tool.h.

◆ subscribe_tool_impl()

template<typename InterprocessType , typename SubscribeConfig >
void goby::middleware::tool::subscribe_tool_impl ( InterprocessType &  interprocess,
const SubscribeConfig &  cfg,
std::map< int, std::unique_ptr< goby::middleware::log::LogPlugin > > &  plugins,
const std::string &  internal_group_regex = "" 
)

Set up subscriptions for the interprocess subscribe tool.

Template Parameters
InterprocessTypeTransport-specific interprocess portal type
SubscribeConfigConfig type with group_regex(), type_regex(), scheme(), has_scheme(), include_internal_groups() accessors
Parameters
interprocessReference to the interprocess portal
cfgSubscribe configuration
pluginsMap of scheme->LogPlugin for deserializing messages
internal_group_regexRegex pattern for internal groups to filter unless include_internal_groups() is set. Pass empty string to disable filtering.

Definition at line 160 of file publish_subscribe_tool.h.