Class FabricScopedAttributeServer<T>

Attribute server which is getting and setting the value for a defined fabric. The values are automatically persisted on fabric level if no custom getter or setter is defined.

Type Parameters

  • T

Hierarchy (view full)

Constructors

constructor

Properties

cluster datasource defaultValue delayedChangeData? endpoint? getter id isFixed isSubscribable isWritable name requiresTimedInteraction schema setter validator value valueChangeListeners valueSetListeners

Accessors

hasFabricSensitiveData readAcl writeAcl

Methods

addValueChangeListener addValueSetListener assignToEndpoint get getLocal getLocalForFabric getWithVersion handleVersionAndTriggerListeners init processSet removeValueChangeListener removeValueSetListener sanitizeFabricSensitiveFields set setLocal setLocalForFabric setRemote subscribe triggerDelayedChangeEvents updated updatedLocal updatedLocalForFabric validateWithSchema

Constructors

constructor

Properties

Readonlycluster

cluster: Cluster<any, any, any, any, any>

Protected Readonlydatasource

datasource: ClusterDatasource<any>

ReadonlydefaultValue

defaultValue: T

Protected OptionaldelayedChangeData

delayedChangeData?: DelayedChangeData

Protected Optionalendpoint

endpoint?: EndpointInterface

Protected Readonlygetter

getter: ((session?: Session, endpoint?: EndpointInterface, isFabricFiltered?: boolean, message?: Message) => T)

Readonlyid

id: AttributeId

ReadonlyisFixed

isFixed = false

ReadonlyisSubscribable

isSubscribable: boolean

ReadonlyisWritable

isWritable: boolean

Readonlyname

name: string

ReadonlyrequiresTimedInteraction

requiresTimedInteraction: boolean

Readonlyschema

schema: TlvSchema<T>

Protected Readonlysetter

setter: ((value: T, session?: Session, endpoint?: EndpointInterface, message?: Message) => boolean)

Protected Readonlyvalidator

validator: ((value: T, session?: Session, endpoint?: EndpointInterface) => void)

Protectedvalue

value: undefined | T

The value is undefined when getter/setter are used. But we still handle the version number here.

Protected ReadonlyvalueChangeListeners

valueChangeListeners: ((value: T, version: number) => void)[]

Protected ReadonlyvalueSetListeners

valueSetListeners: ((newValue: T, oldValue: T) => void)[]

Accessors

hasFabricSensitiveData

  • get hasFabricSensitiveData(): boolean

  • Returns boolean

readAcl

  • get readAcl(): AccessLevel

  • Returns AccessLevel

writeAcl

  • get writeAcl(): AccessLevel

  • Returns AccessLevel

Methods

addValueChangeListener

  • addValueChangeListener(listener): void

  • Add an internal listener that is called when the value of the attribute changes. The listener is called with the new value and the version number.

    Parameters

    • listener: ((value: T, version: number) => void)
        • (value, version): void

        • Parameters

          • value: T
          • version: number

          Returns void

    Returns void

addValueSetListener

  • addValueSetListener(listener): void

  • Add an external listener that is called when the value of the attribute changes. The listener is called with the new value and the old value.

    Parameters

    • listener: ((newValue: T, oldValue: T) => void)
        • (newValue, oldValue): void

        • Parameters

          • newValue: T
          • oldValue: T

          Returns void

    Returns void

assignToEndpoint

get

  • get(session, isFabricFiltered, message?): T

  • Get the value of the attribute. This method is used by the Interaction model to read the value of the attribute and includes the ACL check. It should not be used locally in the code!

    If a getter is defined the value is determined by that getter method.

    Parameters

    Returns T

getLocal

  • getLocal(): T

  • Get the value of the attribute locally. This method should be used locally in the code and does not include the ACL check. If a getter is defined the value is determined by that getter method.

    Returns T

getLocalForFabric

  • getLocalForFabric(fabric): T

  • Get the value of the attribute locally for a special Fabric. This method should be used locally in the code and does not include the ACL check. If a getter is defined this method returns an error and the value should be retrieved directly internally.

    Parameters

    Returns T

getWithVersion

  • getWithVersion(session, isFabricFiltered, message?): {
        value: T;
        version: number;
    }

  • Get the value of the attribute including the version number. This method is used by the Interaction model to read the value of the attribute and includes the ACL check. It should not be used locally in the code!

    If a getter is defined the value is determined by that getter method. The version number is always 0 for fixed attributes.

    Parameters

    Returns {
        value: T;
        version: number;
    }

    • value: T
    • version: number

ProtectedhandleVersionAndTriggerListeners

  • handleVersionAndTriggerListeners(value, oldValue, considerVersionChanged): void

  • Helper Method to handle needed version increases and trigger the relevant listeners. This method is used internally.

    Parameters

    • value: T
    • oldValue: undefined | T
    • considerVersionChanged: boolean

    Returns void

init

  • init(value): void

  • Initialize the attribute with a value. Because the value is stored on fabric level this method only initializes the version number.

    Parameters

    • value: undefined | T

    Returns void

ProtectedprocessSet

  • processSet(value, session?, message?, delayChangeEvents?): void

  • Helper Method to process the set of a value in a generic way. This method is used internally.

    Parameters

    • value: T
    • Optionalsession: Session
    • Optionalmessage: Message
    • OptionaldelayChangeEvents: boolean

    Returns void

removeValueChangeListener

  • removeValueChangeListener(listener): void

  • Remove an internal listener.

    Parameters

    • listener: ((value: T, version: number) => void)
        • (value, version): void

        • Parameters

          • value: T
          • version: number

          Returns void

    Returns void

removeValueSetListener

  • removeValueSetListener(listener): void

  • Remove an external listener.

    Parameters

    • listener: ((newValue: T, oldValue: T) => void)
        • (newValue, oldValue): void

        • Parameters

          • newValue: T
          • oldValue: T

          Returns void

    Returns void

sanitizeFabricSensitiveFields

  • sanitizeFabricSensitiveFields(value, associatedFabric?): any[] | T

  • Sanitize the value of the attribute by removing fabric sensitive fields that do not belong to the associated fabric

    Parameters

    • value: T
    • OptionalassociatedFabric: Fabric

    Returns any[] | T

set

  • set(value, session, message, delayChangeEvents?, preserveFabricIndex?): void

  • Fabric scoped enhancement of set to allow setting special fabricindex locally.

    Parameters

    • value: T
    • session: Session
    • message: Message
    • OptionaldelayChangeEvents: boolean
    • OptionalpreserveFabricIndex: boolean

    Returns void

setLocal

  • setLocal(_value): void

  • Set Local is not allowed for fabric scoped attributes. Use setLocalForFabric instead.

    Parameters

    • _value: T

    Returns void

setLocalForFabric

  • setLocalForFabric(value, fabric): void

  • Set the value of the attribute locally for a fabric. This method should be used locally in the code and does not include the ACL check. If a setter is defined this method cannot be used! If a validator is defined the value is validated before it is stored. Listeners are called when the value changes (internal listeners) or in any case (external listeners).

    Parameters

    Returns void

ProtectedsetRemote

  • setRemote(value, session, message, delayChangeEvents?, preserveFabricIndex?): void

  • Method that contains the logic to set a value "from remote" (e.g. from a client). For Fabric scoped attributes we need to inject the fabric index into the value.

    Parameters

    • value: T
    • session: Session
    • message: Message
    • OptionaldelayChangeEvents: boolean
    • OptionalpreserveFabricIndex: boolean

    Returns void

subscribe

  • subscribe(listener): void

  • Add an external listener that is called when the value of the attribute changes. The listener is called with the new value and the old value. This method is a convenient alias for addValueSetListener.

    Parameters

    • listener: ((newValue: T, oldValue: T) => void)
        • (newValue, oldValue): void

        • Parameters

          • newValue: T
          • oldValue: T

          Returns void

    Returns void

triggerDelayedChangeEvents

updated

  • updated(session): void

  • When the value is handled by getter or setter methods and is changed by other processes this method can be used to notify the attribute server that the value has changed. This will increase the version number and trigger the listeners.

    ACL checks needs to be performed before calling this method.

    Parameters

    Returns void

updatedLocal

  • updatedLocal(): void

  • When the value is handled by getter or setter methods and is changed by other processes and no session from the originating process is known this method can be used to notify the attribute server that the value has changed. This will increase the version number and trigger the listeners.

    ACL checks needs to be performed before calling this method.

    Returns void

updatedLocalForFabric

  • updatedLocalForFabric(fabric): void

  • When the value is handled by getter or setter methods and is changed by other processes and no session from the originating process is known this method can be used to notify the attribute server that the value has changed. This will increase the version number and trigger the listeners. ACL checks needs to be performed before calling this method.

    Parameters

    Returns void

validateWithSchema

  • validateWithSchema(value): void

  • Parameters

    • value: T

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods