Struct SimpleMetricManager 

pub struct SimpleMetricManager<H> { /* private fields */ }

A MetricManager implementation that provides simple metric registration and handling.

SimpleMetricManager provides a simple way to manage metrics with support for command callbacks and metric publishing.

Example

use srad_eon::{SimpleMetricManager, SimpleMetricBuilder};

//Create a new simple metric manager
let manager = SimpleMetricManager::new();

// Assume we successfully create a device with a SimpleMetricManager as it's metrics manager
create_device_with_manager(&manager);

// Register a simple metric
let counter = manager.register_metric(SimpleMetricBuilder::new("Counter", 0 as i32)).unwrap();

// Register a metric with a command handler
let temperature = manager.register_metric(
    SimpleMetricBuilder::new("temperature", 25.5)
    .with_cmd_handler(
        |mgr, metric, new_value| async move {
            if let Some(value) = new_value {
                mgr.publish_metric(metric.update(|x|{ *x = value })).await;
            }
        }
    )
);

Implementations

impl<H> SimpleMetricManager<H>

where H: MetricPublisher + Clone + Send + Sync + 'static,

pub fn new() -> Self

Creates a new empty SimpleMetricManager.

This initialises a new metric manager with no registered metrics.

pub fn register_metric<T>( &self, builder: SimpleMetricBuilder<T, H>, ) -> Option<SimpleManagerMetric<T, H>>

where T: MetricValue + Clone + Send + 'static,

Registers a new metric from the builders settings.

Returns None if a metric with the same name already exists, otherwise returns the newly created metric.

pub async fn publish_metric( &self, metric: SimpleManagerPublishMetric, ) -> Result<(), PublishError>

Publishes a single metric.

Returns an error if the metric was not published.

pub async fn publish_metrics( &self, metrics: Vec<SimpleManagerPublishMetric>, ) -> Result<(), PublishError>

Publishes a multiple metric in a single batch.

Returns an error if the metrics were not published.

Trait Implementations

impl<H: Clone> Clone for SimpleMetricManager<H>

fn clone(&self) -> SimpleMetricManager<H>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<H> Default for SimpleMetricManager<H>

where H: MetricPublisher + Clone + Send + Sync + 'static,

fn default() -> Self

Returns the “default value” for a type.

impl DeviceMetricManager for SimpleMetricManager<DeviceHandle>

fn init(&self, handle: &DeviceHandle)

Initialise the struct.

fn on_dcmd<'life0, 'async_trait>( &'life0 self, __arg1: DeviceHandle, metrics: MessageMetrics, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Processes DCMD metrics.

impl<H> MetricManager for SimpleMetricManager<H>

fn initialise_birth(&self, bi: &mut BirthInitializer)

Initialises the set of metrics to be included in a birth or rebirth message.

impl NodeMetricManager for SimpleMetricManager<NodeHandle>

fn init(&self, handle: &NodeHandle)

Initialise the struct.

fn on_ncmd<'life0, 'async_trait>( &'life0 self, __arg1: NodeHandle, metrics: MessageMetrics, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Processes NCMD metrics.

fn birth_update_template_registry( &self, _template_registry: &mut TemplateRegistry, )

Update the templates registered with the node.