Struct TtlManager 

pub struct TtlManager { /* private fields */ }

TTL Manager for automatic document expiration

Tracks document expiry times and runs background cleanup task to remove expired documents from the store.

Implementations

impl TtlManager

pub fn new(store: Arc<AutomergeStore>, config: TtlConfig) -> TtlManager

Create a new TTL Manager

Arguments

• store - AutomergeStore for document deletion
• config - TTL configuration (beacon_ttl, position_ttl, etc.)

Example

let store = AutomergeStore::new(iroh_transport.clone());
let config = TtlConfig::tactical(); // 30s beacon TTL
let ttl_manager = TtlManager::new(store, config);

pub fn set_ttl(&self, key: &str, ttl: Duration) -> Result<(), Error>

Schedule a document for expiration

Arguments

• key - Full document key in format “collection/doc_id” (e.g., “beacons/node-123”)
• ttl - Time until expiration

Example

// Beacon expires in 30 seconds
ttl_manager.set_ttl("beacons/node-123", Duration::from_secs(30))?;

pub fn cleanup_expired(&self) -> Result<usize, Error>

Remove all expired documents

This method is called by the background cleanup task every 10 seconds. It finds all documents with expiry times <= now and deletes them. Documents are ordered according to the configured eviction strategy (OldestFirst, KeepLastN, etc.) before deletion.

Returns

Number of documents cleaned up

pub fn extend_ttls_for_offline(&self)

Extend TTLs for all pending documents when the node is offline

When no peers are connected, this extends remaining TTLs by the configured offline retention multiplier (offline_ttl / online_ttl ratio). This prevents premature eviction of data that can’t be re-synced.

Should be called periodically from the sync loop when connected_peers() is empty.

pub fn start_background_cleanup(&self)

Start background cleanup task

Spawns a tokio task that runs cleanup_expired() every 10 seconds.

Example

let ttl_manager = TtlManager::new(store, config);
ttl_manager.start_background_cleanup();

pub fn stop_background_cleanup(&self)

Stop background cleanup task

pub fn config(&self) -> &TtlConfig

Get TTL configuration

pub fn pending_count(&self) -> usize

Get count of documents scheduled for expiration

Trait Implementations

impl Drop for TtlManager

fn drop(&mut self)

Executes the destructor for this type.