HybridMonitor

Struct HybridMonitor 

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

Hybrid IP address monitor combining API events with polling fallback.

The hybrid monitor uses platform API events (e.g., NotifyIpInterfaceChange) for immediate notification of IP changes, with periodic polling as a safety net.

§Degradation Behavior

If the API listener fails (returns an error), the monitor automatically degrades to polling-only mode. This degradation is permanent for the lifetime of the stream - no automatic recovery is attempted.

§Type Parameters

  • F - The AddressFetcher implementation for retrieving adapter snapshots
  • L - The ApiListener implementation for platform event notifications
  • C - The Clock implementation for timestamps (defaults to SystemClock)

§Example

use ddns_a::monitor::{HybridMonitor, DebouncePolicy};
use ddns_a::monitor::platform::PlatformListener;
use std::time::Duration;

let fetcher = MyFetcher::new();
let listener = PlatformListener::new()?;
let monitor = HybridMonitor::new(fetcher, listener, Duration::from_secs(60))
    .with_debounce(DebouncePolicy::default());

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

Implementations§

Source§

impl<F, L> HybridMonitor<F, L, SystemClock>

Source

pub const fn new(fetcher: F, api_listener: L, poll_interval: Duration) -> Self

Creates a new hybrid monitor with system clock.

§Arguments
  • fetcher - The address fetcher to use for polling
  • api_listener - The platform API listener for event notifications
  • poll_interval - The interval between polls (safety net for missed events)
Source§

impl<F, L, C> HybridMonitor<F, L, C>
where F: AddressFetcher, L: ApiListener, C: Clock,

Source

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

Creates a new hybrid monitor with a custom clock.

This constructor allows injecting a mock clock for testing.

§Arguments
  • fetcher - The address fetcher to use for polling
  • api_listener - The platform API listener for event notifications
  • clock - The clock to use for timestamps
  • poll_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.

Note: The debounce window is fixed-duration from the first change; subsequent changes within the window do not extend the timer.

§Arguments
  • policy - The debounce policy to apply
Source

pub const fn poll_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) -> HybridStream<F, L::Stream, C>

Converts this monitor into a stream of IP changes.

The returned stream will:

  • React to API events for immediate change detection
  • Poll at the configured interval as a safety net
  • Yield batches of crate::monitor::IpChange events whenever addresses change

If the API listener fails, the stream automatically degrades to polling-only mode without terminating.

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

Trait Implementations§

Source§

impl<F: Debug, L: Debug, C: Debug> Debug for HybridMonitor<F, L, C>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<F, L, C> Freeze for HybridMonitor<F, L, C>
where F: Freeze, L: Freeze, C: Freeze,

§

impl<F, L, C> RefUnwindSafe for HybridMonitor<F, L, C>

§

impl<F, L, C> Send for HybridMonitor<F, L, C>
where F: Send, L: Send, C: Send,

§

impl<F, L, C> Sync for HybridMonitor<F, L, C>
where F: Sync, L: Sync, C: Sync,

§

impl<F, L, C> Unpin for HybridMonitor<F, L, C>
where F: Unpin, L: Unpin, C: Unpin,

§

impl<F, L, C> UnwindSafe for HybridMonitor<F, L, C>
where F: UnwindSafe, L: 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