Class DescriptorServer

This is the default server implementation of DescriptorBehavior.

Hierarchy (view full)

DescriptorBehavior
- DescriptorServer

Constructors

constructor

new DescriptorServer(agent, backing): DescriptorServer
Parameters
- agent: Agent
- backing: BehaviorBacking
Returns DescriptorServer
Inherited from DescriptorBehavior.constructor
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:198

Properties

[reference]

[reference]: Datasource<StateType>

agent

agent: Agent

cluster

cluster: never

The implemented cluster.

`Readonly`events

events: EventEmitter & Omit<Events, never> & {
    clientList$Changing: ClusterEvents.AttributeObservable<FixedAttribute<ClusterId[], any>>;
    deviceTypeList$Changing: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
        deviceType: FieldType<DeviceTypeId>;
        revision: FieldType<number>;
    }>[], any>>;
    partsList$Changing: ClusterEvents.AttributeObservable<Attribute<EndpointNumber[], any>>;
    serverList$Changing: ClusterEvents.AttributeObservable<FixedAttribute<ClusterId[], any>>;
} & {} & {
    clientList$Changed: ClusterEvents.AttributeObservable<FixedAttribute<ClusterId[], any>>;
    deviceTypeList$Changed: ClusterEvents.AttributeObservable<FixedAttribute<TypeFromFields<{
        deviceType: FieldType<DeviceTypeId>;
        revision: FieldType<number>;
    }>[], any>>;
    partsList$Changed: ClusterEvents.AttributeObservable<Attribute<EndpointNumber[], any>>;
    serverList$Changed: ClusterEvents.AttributeObservable<FixedAttribute<ClusterId[], any>>;
} & {} & {} & {}

Access the behavior's events.

features

features: TypeFromBitSchema<{
tagList: BitFlag;
}>

Supported features as a flag object.

Type declaration

ReadonlytagList: BitFlag
TagList

See the Disambiguation section in the System Model spec for conformance requirements for this feature and the corresponding attribute.

See
MatterSpecification.v13.Core § 9.5.4.1

session

session: SecureSession

`Readonly`state

state: Omit<{}, never> & {
    partsList: EndpointNumber[];
} & {} & {
    clientList: ClusterId[];
    deviceTypeList: TypeFromFields<{
        deviceType: FieldType<DeviceTypeId>;
        revision: FieldType<number>;
    }>[];
    serverList: ClusterId[];
} & {}

Access the behavior's state.

Type declaration

ReadonlypartsList: EndpointNumber[]
This attribute indicates composition of the device type instance. Device type instance composition shall include the endpoints in this list.

See Endpoint Composition for more information about which endpoints to include in this list.

See
MatterSpecification.v13.Core § 9.5.6.4

Type declaration

ReadonlyclientList: ClusterId[]
This attribute shall list each cluster ID for the client clusters present on the endpoint instance.

See
MatterSpecification.v13.Core § 9.5.6.3
ReadonlydeviceTypeList: TypeFromFields<{
deviceType: FieldType<DeviceTypeId>;
revision: FieldType<number>;
}>[]
This is a list of device types and corresponding revisions declaring endpoint conformance (see DeviceTypeStruct). At least one device type entry shall be present.

An endpoint shall conform to all device types listed in the DeviceTypeList. A cluster instance that is in common for more than one device type in the DeviceTypeList shall be supported as a shared cluster instance on the endpoint.

See
MatterSpecification.v13.Core § 9.5.6.1
ReadonlyserverList: ClusterId[]
This attribute shall list each cluster ID for the server clusters present on the endpoint instance.

See
MatterSpecification.v13.Core § 9.5.6.2

`Static` `Readonly`cluster

cluster: Descriptor.Cluster

Base cluster state include all attribute values but may be extended by subclasses.

`Static` `Readonly`defaults

defaults: ClusterState.Type<Descriptor.Cluster, typeof ClusterBehavior>

`Static`dependencies

dependencies: typeof IndexBehavior[] = ...

`Static` `Readonly`early

early: boolean

`Static` `Readonly`Events

Events: ClusterEvents.Type<Descriptor.Cluster, typeof ClusterBehavior>

`Static` `Readonly`ExtensionInterface

ExtensionInterface: {}

`Static` `Readonly`id

The behavior ID for ClusterBehaviors is the name of the cluster.

`Static` `Readonly`Interface

Interface: {
components: never[];
}

`Static` `Readonly`Internal

Internal: (new () => {})

`Static` `Readonly`name

name: string

`Static` `Optional` `Readonly`schema

schema?: Schema

`Static` `Readonly`State

State: (new () => ClusterState.Type<Descriptor.Cluster, typeof ClusterBehavior>)

`Static` `Readonly`supervisor

supervisor: RootSupervisor

`Static`supports

supports: ((other: Type) => boolean)

Type declaration

- (other): boolean
- Does this behavior support functionality of a specific implementation?
  Parameters
  - other: Type
  Returns boolean

Methods

[asyncDispose]

[asyncDispose](): MaybePromise
Release resources. This is the public API for releasing application resources held by behaviors in internal state.

Returns MaybePromise
Inherited from DescriptorBehavior.[asyncDispose]
- Defined in packages/node/src/behavior/Behavior.ts:206

addDeviceTypes

addDeviceTypes(...deviceTypes): void
Extend device type metadata. This is a shortcut for deduped insert into the deviceTypeList cluster attribute.
Parameters
- Rest...deviceTypes: (string | TypeFromFields<{
  deviceType: FieldType<DeviceTypeId>;
  revision: FieldType<number>;
  }>)[]
  an array of objects or named device types as defined in MatterModel.standard
Returns void
- Defined in packages/node/src/behaviors/descriptor/DescriptorServer.ts:80

addTags

addTags(...tags): void
Add semantic tags. This is a shortcut for deduped insert into the tagList cluster attribute.

You must enable the "TagList" feature to use this method.
Parameters
- Rest...tags: Semtag[]
Returns void
- Defined in packages/node/src/behaviors/descriptor/DescriptorServer.ts:107

asAdmin

asAdmin(fn): void
Parameters
- fn: (() => void)
  the elevated logic
  - - (): void
    - Returns void
Returns void
Inherited from DescriptorBehavior.asAdmin
- Defined in packages/node/src/behavior/Behavior.ts:135

assertAttributeEnabled

assertAttributeEnabled<This, K>(this, attributeName): void
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns void
Inherited from DescriptorBehavior.assertAttributeEnabled
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:180

`Protected`callback

callback<A, R>(reactor, options?): ((...args: A) => undefined | R)
Create a generic callback function that has the same properties as a Reactor.

Like a reactor, the callback's "this" will be bound to an active Behavior instance. Because of this: The reactor MUST be a real JS function - arrow functions will not work!
Type Parameters
- A extends any[]
- R
Parameters
- reactor: Reactor<A, R>
- Optionaloptions: Reactor.Options
Returns ((...args: A) => undefined | R)
- - (...args): undefined | R
  - Parameters
    - Rest...args: A
    Returns undefined | R
Inherited from DescriptorBehavior.callback
- Defined in packages/node/src/behavior/Behavior.ts:234

hasDeviceType

hasDeviceType(type): boolean
Check for presence of a device type.
Parameters
- type: DeviceTypeId
Returns boolean
- Defined in packages/node/src/behaviors/descriptor/DescriptorServer.ts:136

initialize

initialize(): Promise<void>
Behaviors are ephemeral and should not perform initialization in their constructor. They can override this method instead.

This method may be synchronous or asyncronous. If asynchronous, the behavior will not be available for external use until initialization completes.

Returns Promise<void>
Overrides DescriptorBehavior.initialize
- Defined in packages/node/src/behaviors/descriptor/DescriptorServer.ts:22

`Protected`reactTo

reactTo<O>(observable, reactor, options?): void
Install a Reactor.

Important: The reactor MUST be a real JS function - arrow functions will not work!
Type Parameters
- O extends Observable<any[], any>
Parameters
- observable: O
- reactor: Reactor<Parameters<O["emit"]>, ReturnType<O["emit"]>>
- Optionaloptions: Reactor.Options
Returns void
Inherited from DescriptorBehavior.reactTo
- Defined in packages/node/src/behavior/Behavior.ts:220

requireAttributeEnabled

requireAttributeEnabled<This, K>(this, attributeName): Exclude<This["state"][K], undefined>
Type Parameters
- This extends Behavior
- K extends string | number | symbol
Parameters
- this: This
- attributeName: K
Returns Exclude<This["state"][K], undefined>
Inherited from DescriptorBehavior.requireAttributeEnabled
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:168

toString

toString(): string
Returns string
Inherited from DescriptorBehavior.toString
- Defined in packages/node/src/behavior/Behavior.ts:211

`Static`alter

alter<This, const AlterationsT>(this, alterations): Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const AlterationsT extends Alterations<This["cluster"]>
Parameters
- this: This
- alterations: AlterationsT
Returns Type<WithAlterations<This["cluster"], AlterationsT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from DescriptorBehavior.alter
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:251

`Static`enable

enable<This, const FlagsT>(this, flags): Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FlagsT extends ElementFlags<This["cluster"]>
Parameters
- this: This
- flags: FlagsT
Returns Type<WithAlterations<This["cluster"], ElementFlagAlterations<FlagsT>>, This, ClusterInterface.InterfaceOf<This>>
Inherited from DescriptorBehavior.enable
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:261

`Static`for

for<This, const ClusterT>(this, cluster, schema?): Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const ClusterT extends ClusterType
Parameters
- this: This
- cluster: ClusterT
- Optionalschema: Schema
Returns Type<ClusterT, This, ClusterInterface.InterfaceOf<This>>
Inherited from DescriptorBehavior.for
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:237

`Static`set

set<This>(this, defaults): This
Type Parameters
- This extends Type
Parameters
- this: This
- defaults: Partial<RelaxTypes<InstanceType<This["State"]>>>
Returns This
Inherited from DescriptorBehavior.set
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:259

`Static`with

with<This, const FeaturesT>(this, ...features): Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Type Parameters
- This extends Type<ClusterType, Type, ClusterInterface<{}>>
- const FeaturesT extends FeatureSelection<This["cluster"]>
Parameters
- this: This
- Rest...features: FeaturesT
Returns Type<WithFeatures<This["cluster"], FeaturesT>, This, ClusterInterface.InterfaceOf<This>>
Inherited from DescriptorBehavior.with
- Defined in packages/node/src/behavior/cluster/ClusterBehavior.ts:243

Class DescriptorServer

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns DescriptorServer

Properties

[reference]

agent

cluster

context

endpoint

env

Readonlyevents

features

Type declaration

ReadonlytagList: BitFlag

See

session

Readonlystate

Type declaration

ReadonlypartsList: EndpointNumber[]

See

Type declaration

ReadonlyclientList: ClusterId[]

See

ReadonlydeviceTypeList: TypeFromFields<{ deviceType: FieldType<DeviceTypeId>; revision: FieldType<number>; }>[]

See

ReadonlyserverList: ClusterId[]

See

Static Readonlycluster

Static Readonlydefaults

Staticdependencies

Static Readonlyearly

Static ReadonlyEvents

Static ReadonlyExtensionInterface

Static Readonlyid

Static ReadonlyInterface

Static ReadonlyInternal

Static Readonlyname

Static Optional Readonlyschema

Static ReadonlyState

Static Readonlysupervisor

Staticsupports

Type declaration

Parameters

Returns boolean

Methods

[asyncDispose]

Returns MaybePromise

addDeviceTypes

Parameters

Returns void

addTags

Parameters

Returns void

asAdmin

Parameters

Returns void

Returns void

assertAttributeEnabled

Type Parameters

Parameters

Returns void

Protectedcallback

Type Parameters

Parameters

Returns ((...args: A) => undefined | R)

Parameters

Returns undefined | R

hasDeviceType

Parameters

Returns boolean

initialize

Returns Promise<void>

ProtectedreactTo

`Readonly`events

`Readonly`tagList: BitFlag

`Readonly`state

`Readonly`partsList: EndpointNumber[]

`Readonly`clientList: ClusterId[]

`Readonly`deviceTypeList: TypeFromFields<{
deviceType: FieldType<DeviceTypeId>;
revision: FieldType<number>;
}>[]

`Readonly`serverList: ClusterId[]

`Static` `Readonly`cluster

`Static` `Readonly`defaults

`Static`dependencies

`Static` `Readonly`early

`Static` `Readonly`Events

`Static` `Readonly`ExtensionInterface

`Static` `Readonly`id

`Static` `Readonly`Interface

`Static` `Readonly`Internal

`Static` `Readonly`name

`Static` `Optional` `Readonly`schema

`Static` `Readonly`State

`Static` `Readonly`supervisor

`Static`supports

`Protected`callback

`Protected`reactTo

`Static`alter

`Static`enable

`Static`for

`Static`set

`Static`with