Class LiveSettingsTarget

Namespace

RDCore.SDK.Server.Configuration

Assembly

RDCore.SDK.dll

The settings of a settings object that take effect while a component runs (Live): the object's settings in a schema, and the section of the configuration the object is bound from.

public sealed class LiveSettingsTarget

Inheritance

object

LiveSettingsTarget

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The object is the one the component reads its settings off - the instance of its IOptions<T> - and a live setting is set on it in place, so that what reads the setting when it uses it reads the new value. What copied a value when it started keeps the one it copied: a setting that is read so is not a live one, whatever it is marked.

Constructors

LiveSettingsTarget(SettingsSchema, string, object)

The settings of a settings object that take effect while a component runs (Live): the object's settings in a schema, and the section of the configuration the object is bound from.

public LiveSettingsTarget(SettingsSchema schema, string section, object root)

Parameters

schema SettingsSchema

The settings, of which the live ones of section are this object's.

section string

The key of the section the object is bound from, under Root; empty for an object whose properties are the sections.

root object

The settings object.

Remarks

The object is the one the component reads its settings off - the instance of its IOptions<T> - and a live setting is set on it in place, so that what reads the setting when it uses it reads the new value. What copied a value when it started keeps the one it copied: a setting that is read so is not a live one, whatever it is marked.

Properties

Root

The settings object.

public object Root { get; }

Property Value

object