NodeHandle

Struct NodeHandle 

Source
pub struct NodeHandle { /* private fields */ }
Expand description

A handle for interacting with the Edge Node.

NodeHandle provides an interface for interacting with an edge node, including device management, node lifecycle operations, and metric publishing.

Implementations§

Source§

impl NodeHandle

Source

pub async fn cancel(&self)

Stop all operations, sending a death certificate and disconnect from the broker.

This will cancel EoN::run()

Source

pub fn rebirth(&self)

Manually trigger a rebirth for the node

Source

pub fn register_device<S, M>( &self, name: S, dev_impl: M, ) -> Result<DeviceHandle, DeviceRegistrationError>
where S: Into<String>, M: DeviceMetricManager + Send + Sync + 'static,

Registers a new device with the node.

Returns an error if:

  • A device with the same name is already registered
  • The device name is invalid
Source

pub async fn unregister_device(&self, handle: DeviceHandle)

Unregister a device using it’s handle.

Source

pub async fn unregister_device_named(&self, name: &String)

Unregister a device using it’s name.

Trait Implementations§

Source§

impl Clone for NodeHandle

Source§

fn clone(&self) -> NodeHandle

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl MetricPublisher for NodeHandle

Source§

async fn try_publish_metrics_unsorted( &self, metrics: Vec<PublishMetric>, ) -> Result<(), PublishError>

Attempts to publish a batch of metrics without modifying their order.
Source§

async fn publish_metrics_unsorted( &self, metrics: Vec<PublishMetric>, ) -> Result<(), PublishError>

Publish a batch of metrics without modifying their order.
Source§

fn try_publish_metric( &self, metric: PublishMetric, ) -> impl Future<Output = Result<(), PublishError>> + Send

Attempts to publish a single metric.
Source§

fn try_publish_metrics( &self, metrics: Vec<PublishMetric>, ) -> impl Future<Output = Result<(), PublishError>> + Send

Attempts to publish a batch of metrics after sorting by timestamp.
Source§

fn publish_metric( &self, metric: PublishMetric, ) -> impl Future<Output = Result<(), PublishError>> + Send

Publish a single metric.
Source§

fn publish_metrics( &self, metrics: Vec<PublishMetric>, ) -> impl Future<Output = Result<(), PublishError>> + Send

Publish a batch of metrics after sorting by timestamp.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.