Class AttributeServer<T>

Attribute server for normal attributes that can be read and written.

Type Parameters

Hierarchy (view full)

FixedAttributeServer<T>
- AttributeServer
  - FabricScopedAttributeServer

Constructors

constructor

new AttributeServer<T>(id, name, readAcl, writeAcl, schema, isWritable, isSubscribable, requiresTimedInteraction, initValue, defaultValue, datasource, getter?, setter?, validator?): AttributeServer<T>
Type Parameters
- T
Parameters
- id: AttributeId
- name: string
- readAcl: undefined | AccessLevel
- writeAcl: undefined | AccessLevel
- schema: TlvSchema<T>
- isWritable: boolean
- isSubscribable: boolean
- requiresTimedInteraction: boolean
- initValue: T
- defaultValue: undefined | T
- datasource: ClusterDatasource<any>
- Optionalgetter: ((session?: Session, endpoint?: EndpointInterface, isFabricFiltered?: boolean, message?: Message) => T)
  - - (session?, endpoint?, isFabricFiltered?, message?): T
    - Parameters
      Optionalsession: Session
      Optionalendpoint: EndpointInterface
      OptionalisFabricFiltered: boolean
      Optionalmessage: Message
      Returns T
- Optionalsetter: ((value: T, session?: Session, endpoint?: EndpointInterface, message?: Message) => boolean)
  Optional setter function to handle special requirements or the data are stored in different places. If a setter method is used for a writable attribute, the getter method must be implemented as well. The method needs to return if the stored value has changed or not.
  - - (value, session?, endpoint?, message?): boolean
    - Parameters
      value: T
      the value to be set.
      
      Optionalsession: Session
      the session that is requesting the value (if any).
      
      Optionalendpoint: EndpointInterface
      the endpoint the cluster server of this attribute is assigned to.
      
      Optionalmessage: Message
      Returns boolean
      true if the value has changed, false otherwise.
- Optionalvalidator: ((value: T, session?: Session, endpoint?: EndpointInterface) => void)
  Optional Validator function to handle special requirements for verification of stored data. The method should throw an error if the value is not valid. If a StatusResponseError is thrown this one is also returned to the client.
  
  If a setter is used then no validator should be used as the setter should handle the validation itself!
  - - (value, session?, endpoint?): void
    - Parameters
      value: T
      the value to be set.
      
      Optionalsession: Session
      the session that is requesting the value (if any).
      
      Optionalendpoint: EndpointInterface
      the endpoint the cluster server of this attribute is assigned to.
      
      Returns void
Returns AttributeServer<T>
Overrides FixedAttributeServer.constructor
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:378

Properties

`Protected` `Readonly`datasource

datasource: ClusterDatasource<any>

`Readonly`defaultValue

defaultValue: T

`Protected` `Optional`delayedChangeData

delayedChangeData?: DelayedChangeData = undefined

`Protected` `Optional`endpoint

endpoint?: EndpointInterface

`Protected` `Readonly`getter

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

`Readonly`id

id: AttributeId

`Readonly`isFixed

isFixed = false

`Readonly`isSubscribable

isSubscribable: boolean

`Readonly`isWritable

isWritable: boolean

`Readonly`name

name: string

`Readonly`requiresTimedInteraction

requiresTimedInteraction: boolean

`Readonly`schema

schema: TlvSchema<T>

`Protected` `Readonly`setter

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

`Protected` `Readonly`validator

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

`Protected`value

value: undefined | T = undefined

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

`Protected` `Readonly`valueChangeListeners

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

`Protected` `Readonly`valueSetListeners

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

Accessors

hasFabricSensitiveData

get hasFabricSensitiveData(): boolean
Returns boolean
Inherited from FixedAttributeServer.hasFabricSensitiveData
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:181

readAcl

get readAcl(): AccessLevel
Returns AccessLevel
Inherited from FixedAttributeServer.readAcl
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:211

writeAcl

get writeAcl(): AccessLevel
Returns AccessLevel
Inherited from FixedAttributeServer.writeAcl
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:207

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
Overrides FixedAttributeServer.addValueChangeListener
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:595

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
Overrides FixedAttributeServer.addValueSetListener
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:613

assignToEndpoint

assignToEndpoint(endpoint): void
Parameters
- endpoint: EndpointInterface
Returns void
Inherited from FixedAttributeServer.assignToEndpoint
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:197

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
- session: Session
- isFabricFiltered: boolean
- Optionalmessage: Message
Returns T
Inherited from FixedAttributeServer.get
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:284

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
Inherited from FixedAttributeServer.getLocal
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:306

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
- session: Session
- isFabricFiltered: boolean
- Optionalmessage: Message
Returns {
value: T;
version: number;
}
- value: T
- version: number
Inherited from FixedAttributeServer.getWithVersion
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:297

`Protected`handleVersionAndTriggerListeners

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
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:546

init

init(value): void
Initialize the value of the attribute, used when a persisted value is set initially or when values needs to be adjusted before the Device gets announced. Do not use this method to change values when the device is in use!
Parameters
- value: undefined | T
Returns void
Overrides FixedAttributeServer.init
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:464

`Protected`processSet

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
- delayChangeEvents: boolean = false
Returns void
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:517

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
Overrides FixedAttributeServer.removeValueChangeListener
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:602

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
Overrides FixedAttributeServer.removeValueSetListener
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:628

set

set(value, session, message?, delayChangeEvents?): void
Set the value of the attribute. This method is used by the Interaction model to write the value of the attribute and includes the ACL check. It should not be used locally in the code!

If a setter is defined this setter method is called to store the value.

Listeners are called when the value changes (internal listeners) or in any case (external listeners).
Parameters
- value: T
- session: Session
- Optionalmessage: Message
- delayChangeEvents: boolean = false
Returns void
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:483

setLocal

setLocal(value): void
Set the value of the attribute locally. This method should be used locally in the code and does not include the ACL check.

If a setter is defined this setter method is called to validate and store the value.

Else 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
- value: T
Returns void
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:509

`Protected`setRemote

setRemote(value, session, message?, delayChangeEvents?): void
Method that contains the logic to set a value "from remote" (e.g. from a client).
Parameters
- value: T
- session: Session
- Optionalmessage: Message
- delayChangeEvents: boolean = false
Returns void
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:494

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
Overrides FixedAttributeServer.subscribe
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:621

triggerDelayedChangeEvents

triggerDelayedChangeEvents(): void
Returns void
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:533

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
- session: SecureSession
Returns void
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:563

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
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:585

validateWithSchema

validateWithSchema(value): void
Parameters
- value: T
Returns void
Inherited from FixedAttributeServer.validateWithSchema
- Defined in packages/protocol/src/cluster/server/AttributeServer.ts:185

Class AttributeServer<T>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Parameters

Returns T

Parameters

Returns boolean

Parameters

Returns void

Returns AttributeServer<T>

Properties

Protected Readonlydatasource

ReadonlydefaultValue

Protected OptionaldelayedChangeData

Protected Optionalendpoint

Protected Readonlygetter

Readonlyid

ReadonlyisFixed

ReadonlyisSubscribable

ReadonlyisWritable

Readonlyname

ReadonlyrequiresTimedInteraction

Readonlyschema

Protected Readonlysetter

Protected Readonlyvalidator

Protectedvalue

Protected ReadonlyvalueChangeListeners

Protected ReadonlyvalueSetListeners

Accessors

hasFabricSensitiveData

Returns boolean

readAcl

Returns AccessLevel

writeAcl

Returns AccessLevel

Methods

addValueChangeListener

Parameters

Parameters

Returns void

Returns void

addValueSetListener

Parameters

Parameters

Returns void

Returns void

assignToEndpoint

Parameters

Returns void

get

Parameters

Returns T

getLocal

Returns T

getWithVersion

Parameters

Returns { value: T; version: number; }

value: T

version: number

ProtectedhandleVersionAndTriggerListeners

Parameters

Returns void

init

Parameters

Returns void

ProtectedprocessSet

Parameters

Returns void

removeValueChangeListener

Parameters

Parameters

`Protected` `Readonly`datasource

`Readonly`defaultValue

`Protected` `Optional`delayedChangeData

`Protected` `Optional`endpoint

`Protected` `Readonly`getter

`Readonly`id

`Readonly`isFixed

`Readonly`isSubscribable

`Readonly`isWritable

`Readonly`name

`Readonly`requiresTimedInteraction

`Readonly`schema

`Protected` `Readonly`setter

`Protected` `Readonly`validator

`Protected`value

`Protected` `Readonly`valueChangeListeners

`Protected` `Readonly`valueSetListeners

Returns {
value: T;
version: number;
}

`Protected`handleVersionAndTriggerListeners

`Protected`processSet

`Protected`setRemote