Class RemoteConfigurationOptions

Namespace

Quilt4Net.Toolkit

Assembly

Quilt4Net.Toolkit.dll

public record RemoteConfigurationOptions : IEquatable<RemoteConfigurationOptions>

Inheritance

object

RemoteConfigurationOptions

Implements

IEquatable<RemoteConfigurationOptions>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

ApiKey

public string ApiKey { get; set; }

Property Value

string

Application

Application name used when a read passes application: null (i.e. "this application"). When null (the default), the entry assembly name is used. Set to an empty string to resolve such calls to shared (cross-application) values, or to a specific name to impersonate another application.

Note: the read methods' own application parameter defaults to an empty string (shared), so this option only takes effect for calls that explicitly pass null.

public string Application { get; set; }

Property Value

string

HttpTimeout

Timeout for HTTP calls to the Quilt4Net server. Default is 5 seconds. When a stale cached value exists and StaleWhileRevalidate is enabled, the caller gets the stale value immediately and the refresh happens in the background, so this timeout only blocks when no cached value exists. When StaleWhileRevalidate is disabled, an expired entry is refreshed synchronously and this timeout applies to that call.

public TimeSpan HttpTimeout { get; set; }

Property Value

TimeSpan

Quilt4NetAddress

Address to the Quilt4Net server. Default is https://quilt4net.com/. Defaulted on the type so an unbound IOptions<RemoteConfigurationOptions> still carries a usable URL.

public string Quilt4NetAddress { get; set; }

Property Value

string

StaleWhileRevalidate

When true (default), an expired cache entry is returned immediately and refreshed in the background (stale-while-revalidate) — fast, but the caller may see one slightly stale value. When false, an expired entry is refreshed synchronously so the caller always gets a fresh value (subject to HttpTimeout), at the cost of blocking on the refresh.

public bool StaleWhileRevalidate { get; set; }

Property Value

bool

Ttl

public TimeSpan? Ttl { get; set; }

Property Value

TimeSpan?