Buzzware.Cascade.CascadeConfig Class Reference

User configuration class for the Cascade library. More...

Public Member Functions
int	GetFreshnessSeconds (Type model, int? customValue=null)
	Computes freshness seconds for a type depending on an optional passed in customValue, ModelConfig.FreshnessSeconds, DefaultFreshnessSeconds, ModelConfig.MaximumFreshnessSeconds and DefaultMaximumFreshnessSeconds. Attempts to get a ModelConfig for the type, and defaults to DefaultFreshnessSeconds. A given customValue may override the above. If a MaximumFreshnessSeconds or DefaultMaximumFreshnessSeconds is set, the value is constrained by that and returned.
int	GetFallbackFreshnessSeconds (Type model)
int	GetBlobFreshnessSeconds (int? customValue=null)

Public Attributes
int	MaxParallelRequests = 8
int?	DefaultMaximumFreshnessSeconds = null
	Limit to freshness for blobs and model types that don't have a ModelConfig. Use this for testing ie set it to 120 seconds and you will only have to wait 2 minutes for data to be loaded fresh.
int	DefaultFreshnessSeconds = RequestOp.FRESHNESS_DEFAULT
	Default duration, in seconds, for which data is considered fresh.
int	DefaultPopulateFreshnessSeconds = RequestOp.FRESHNESS_DEFAULT
	Default duration, in seconds, for which populated data is considered fresh.
int	DefaultFallbackFreshnessSeconds = RequestOp.FALLBACK_ANY
	Freshness value for when ConnectionOnline = True and network requests fail.
int	BlobFreshnessSeconds = RequestOp.FRESHNESS_DEFAULT
	Default freshness value for blobs.
int	BlobFallbackFreshnessSeconds = RequestOp.FALLBACK_ANY
	Default fallback freshness value for blobs.
string	StoragePath
	Root directory path for all files written by Cascade.

Properties
string	PendingChangesPath [get]
	Path for storing pending changes.
string	HoldPath [get]
	Path for storing the hold status of records.
string	MetaPath [get]
	Path for storing user metadata.
string	FileCachePath [get]
	Path for storing cache files.
IDictionary< Type, ModelConfig >	ModelConfig = new Dictionary<Type, ModelConfig>() [get]

Detailed Description

User configuration class for the Cascade library.

Member Function Documentation

GetFreshnessSeconds()

int Buzzware.Cascade.CascadeConfig.GetFreshnessSeconds ( Type model, int? customValue = null )

inline

Computes freshness seconds for a type depending on an optional passed in customValue, ModelConfig.FreshnessSeconds, DefaultFreshnessSeconds, ModelConfig.MaximumFreshnessSeconds and DefaultMaximumFreshnessSeconds. Attempts to get a ModelConfig for the type, and defaults to DefaultFreshnessSeconds. A given customValue may override the above. If a MaximumFreshnessSeconds or DefaultMaximumFreshnessSeconds is set, the value is constrained by that and returned.

Parameters

model
customValue

Returns

freshness value to use

---

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

• Buzzware.Cascade/CascadeConfig.cs