Zero Install .NET API 2.20.0
ZeroInstall.Services.Feeds.FeedManager Class Reference

Provides access to remote and local Feeds. Handles downloading and signature verification. More...

Inheritance diagram for ZeroInstall.Services.Feeds.FeedManager:
ZeroInstall.Services.Feeds.IFeedManager

Public Member Functions

 FeedManager (Config config, IFeedCache feedCache, ITrustManager trustManager, ITaskHandler handler)
 Creates a new feed manager. More...
 
FeedPreferences GetPreferences (FeedUri feedUri)
 Returns FeedPreferences for a specific feed. More...
 
bool IsStale (FeedUri feedUri)
 Determines whether there is a stale cached copy of a particular feed. More...
 
bool RateLimit (FeedUri feedUri)
 Ensures that operations regarding a specific feed do not happen to often in a row. More...
 
void ImportFeed (string path)
 Imports a remote Feed into the IFeedCache after verifying its signature. More...
 
void Clear ()
 Clears any in-memory caches. More...
 

Properties

bool Refresh [getset]
 Set to true to re-download Feeds even if they are already in the IFeedCache. More...
 
bool Stale [getset]
 
bool ShouldRefresh [get]
 
Feed this[FeedUri feedUri] [get]
 
- Properties inherited from ZeroInstall.Services.Feeds.IFeedManager
bool Refresh [getset]
 Set to true to re-download Feeds even if they are already in the IFeedCache.
 
bool Stale [getset]
 Is set to true if any Feed returned by this is getting stale and should be updated by setting Refresh to true. More...
 
bool ShouldRefresh [get]
 Indicates whether Stale is true and Config.NetworkUse is NetworkLevel.Full.
 
Feed this[FeedUri feedUri] [get]
 Returns a specific Feed. Automatically handles downloading, calling Feed.Normalize and caching. Updates the Stale indicator. More...
 

Detailed Description

Provides access to remote and local Feeds. Handles downloading and signature verification.

This class performs in-memory caching of Feeds and FeedPreferences.

Constructor & Destructor Documentation

◆ FeedManager()

ZeroInstall.Services.Feeds.FeedManager.FeedManager ( Config  config,
IFeedCache  feedCache,
ITrustManager  trustManager,
ITaskHandler  handler 
)
inline

Creates a new feed manager.

Parameters
configUser settings controlling network behaviour, solving, etc.
feedCacheThe disk-based cache to store downloaded Feeds.
trustManagerMethods for verifying signatures and user trust.
handlerA callback object used when the the user needs to be asked questions or informed about download and IO tasks.

Member Function Documentation

◆ Clear()

void ZeroInstall.Services.Feeds.FeedManager.Clear ( )
inline

Clears any in-memory caches.

Implements ZeroInstall.Services.Feeds.IFeedManager.

◆ GetPreferences()

FeedPreferences ZeroInstall.Services.Feeds.FeedManager.GetPreferences ( FeedUri  feedUri)

Returns FeedPreferences for a specific feed.

Implements ZeroInstall.Services.Feeds.IFeedManager.

◆ ImportFeed()

void ZeroInstall.Services.Feeds.FeedManager.ImportFeed ( string  path)
inline

Imports a remote Feed into the IFeedCache after verifying its signature.

Implements ZeroInstall.Services.Feeds.IFeedManager.

◆ IsStale()

bool ZeroInstall.Services.Feeds.FeedManager.IsStale ( FeedUri  feedUri)
inline

Determines whether there is a stale cached copy of a particular feed.

Implements ZeroInstall.Services.Feeds.IFeedManager.

◆ RateLimit()

bool ZeroInstall.Services.Feeds.FeedManager.RateLimit ( FeedUri  feedUri)
inline

Ensures that operations regarding a specific feed do not happen to often in a row.

Implements ZeroInstall.Services.Feeds.IFeedManager.

Property Documentation

◆ Refresh

bool ZeroInstall.Services.Feeds.FeedManager.Refresh
getset

Set to true to re-download Feeds even if they are already in the IFeedCache.

Setting this to true implicitly also flushes the in-memory cache.


The documentation for this class was generated from the following file: