Struct RefreshRegistry

Source

pub struct RefreshRegistry { /* private fields */ }

Expand description

Global registry for refresh signals that can trigger provider re-execution

The RefreshRegistry manages the reactive update system for providers. It tracks which reactive contexts are subscribed to which providers, maintains refresh counters, and manages periodic tasks for both auto-refreshing and stale-checking.

§Thread Safety

All internal state is protected by mutexes to ensure thread-safe access across different contexts and background tasks.

Implementations§

Source §

impl RefreshRegistry

Source

pub fn new() -> Self

Create a new refresh registry

Source

pub fn get_refresh_count(&self, key: &str) -> u64

Get the current refresh count for a provider key

Returns the number of times the provider has been refreshed, or 0 if not found.

Source

pub fn subscribe_to_refresh(&self, key: &str, reactive_context: ReactiveContext)

Subscribe a reactive context to refresh events for a provider key

When the provider is refreshed, the reactive context will be marked as dirty, causing any components using it to re-render.

Source

pub fn trigger_refresh(&self, key: &str)

Trigger a refresh for a provider key

This increments the refresh counter and marks all subscribed reactive contexts as dirty, causing components to re-render and providers to re-execute.

Source

pub fn clear_all(&self)

Clear all cached data and trigger refresh for all providers

This is useful for global cache invalidation scenarios.

Source

pub fn start_periodic_task<F>( &self, key: &str, task_type: TaskType, interval: Duration, task_fn: F, )
where F: Fn() + Send + 'static,

Start a periodic task for automatic provider operations

Creates a background task that will call the provided function at regular intervals. Supports both interval refresh and stale checking operations. If an existing task exists with a longer interval, it will be replaced. Tasks with shorter intervals are preserved to avoid unnecessary re-creation.

§Cross-Platform Implementation

Uses dioxus::spawn to create tasks that work on both web and desktop platforms. Tasks can be cancelled explicitly using stop_* methods, which set a cancellation flag.

Source

pub fn start_interval_task<F>( &self, key: &str, interval: Duration, refresh_fn: F, )
where F: Fn() + Send + 'static,

Start an interval task for automatic provider refresh

This is a convenience method for starting interval refresh tasks.

Source

pub fn start_stale_check_task<F>( &self, key: &str, stale_time: Duration, stale_check_fn: F, )
where F: Fn() + Send + 'static,

Start a stale check task for SWR behavior

This is a convenience method for starting stale checking tasks.

Source

pub fn stop_periodic_task(&self, key: &str, task_type: TaskType)

Stop a periodic task

Signals the task to stop by setting its cancellation flag and removes it from the registry. The task will stop after its current iteration completes.

Source

pub fn stop_interval_task(&self, key: &str)

Stop an interval task

This is a convenience method for stopping interval refresh tasks.

Source

pub fn stop_stale_check_task(&self, key: &str)

Stop a stale check task

This is a convenience method for stopping stale checking tasks.

Source

pub fn is_revalidation_in_progress(&self, key: &str) -> bool

Check if a revalidation is currently in progress for a provider key

This prevents duplicate revalidations from being started simultaneously.

Source

pub fn start_revalidation(&self, key: &str) -> bool

Start a revalidation for a provider key

Returns true if the revalidation was started, false if one was already in progress. This prevents duplicate revalidations from running simultaneously.

Source