Struct MqttPlugin

pub struct MqttPlugin;

Trait Implementations

impl Plugin for MqttPlugin

const DEFAULT_NAME: &'static str = "mqtt"

Plugins’ default name when statically linked.

const PLUGIN_LONG_VERSION: &'static str = "v1.2.0"

Plugin’s long version (with git commit hash). Used only for information purposes. It’s recommended to use plugin_version! macro to generate this string.

const PLUGIN_VERSION: &'static str = "1.2.0"

Plugin’s version. Used only for information purposes. It’s recommended to use plugin_version! macro to generate this string.

type StartArgs = Runtime

type Instance = Box<dyn RunningPluginTrait + Send + Sync>

fn start(name: &str, runtime: &Self::StartArgs) -> ZResult<RunningPlugin>

Starts your plugin. Use Ok to return your plugin’s control structure

impl PluginControl for MqttPlugin

fn report(&self) -> PluginReport

Returns the current state of the running plugin. By default, the state is PluginReportLevel::Normal and the list of messages is empty. This can be overridden by the plugin implementation if the plugin is able to report its status: no connection to the database, etc.

fn plugins_status(&self, _names: &keyexpr) -> Vec<PluginStatusRec<'_>>

Collects information of sub-plugins matching the _names key expression. The information is richer than the one returned by report(): it contains external information about the running plugin, such as its name, path on disk, load status, etc. Returns an empty list by default.

impl RunningPluginTrait for MqttPlugin

fn config_checker( &self, _path: &str, _current: &Map<String, Value>, _new: &Map<String, Value>, ) -> Result<Option<Map<String, Value>>, Box<dyn Error + Send + Sync>>

Function that will be called when configuration relevant to the plugin is about to change.

fn adminspace_getter<'a>( &'a self, _key_expr: &'a KeyExpr<'a>, _plugin_status_key: &str, ) -> Result<Vec<Response>, Box<dyn Error + Send + Sync>>

Used to request plugin’s status for the administration space. Function called on any query on admin space that matches this plugin’s sub-part of the admin space. Thus the plugin can reply its contribution to the global admin space of this zenohd. Parameters:

impl ZenohPlugin for MqttPlugin