PollingMonitor

Struct PollingMonitor 

Source
pub struct PollingMonitor<F, C = SystemClock> { /* private fields */ }
Expand description

Polling-based IP address monitor.

Periodically fetches network adapter information and emits a stream of super::super::IpChange events when addresses are added or removed.

§Type Parameters

§Example

use ddns_a::monitor::PollingMonitor;
use ddns_a::time::SystemClock;
use std::time::Duration;

let fetcher = MyFetcher::new();
let monitor = PollingMonitor::new(fetcher, Duration::from_secs(60));

let mut stream = monitor.into_stream();
while let Some(changes) = stream.next().await {
    for change in changes {
        println!("{:?}", change);
    }
}

Implementations§

Source§

impl<F> PollingMonitor<F, SystemClock>
where F: AddressFetcher,

Source

pub const fn new(fetcher: F, interval: Duration) -> Self

Creates a new polling monitor with system clock.

§Arguments
  • fetcher - The address fetcher to use for polling
  • interval - The interval between polls
Source§

impl<F, C> PollingMonitor<F, C>
where F: AddressFetcher, C: Clock,

Source

pub const fn with_clock(fetcher: F, clock: C, interval: Duration) -> Self

Creates a new polling monitor with a custom clock.

This constructor allows injecting a mock clock for testing.

§Arguments
  • fetcher - The address fetcher to use for polling
  • clock - The clock to use for timestamps
  • interval - The interval between polls
Source

pub const fn with_debounce(self, policy: DebouncePolicy) -> Self

Configures debounce policy for this monitor.

When debounce is enabled, rapid consecutive changes within the debounce window are merged, with cancelling changes (add then remove of the same IP) being eliminated.

§Arguments
  • policy - The debounce policy to apply
Source

pub const fn interval(&self) -> Duration

Returns the configured polling interval.

Source

pub const fn debounce(&self) -> Option<&DebouncePolicy>

Returns the configured debounce policy, if any.

Source

pub fn into_stream(self) -> PollingStream<F, C>

Converts this monitor into a stream of IP changes.

The returned stream will poll at the configured interval and yield batches of super::super::IpChange events whenever addresses change.

The stream never terminates on its own; use take_until with a shutdown signal to stop it gracefully.

Auto Trait Implementations§

§

impl<F, C> Freeze for PollingMonitor<F, C>
where F: Freeze, C: Freeze,

§

impl<F, C> RefUnwindSafe for PollingMonitor<F, C>

§

impl<F, C> Send for PollingMonitor<F, C>
where F: Send, C: Send,

§

impl<F, C> Sync for PollingMonitor<F, C>
where F: Sync, C: Sync,

§

impl<F, C> Unpin for PollingMonitor<F, C>
where F: Unpin, C: Unpin,

§

impl<F, C> UnwindSafe for PollingMonitor<F, C>
where F: UnwindSafe, C: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. 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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more