Class TransactionalInteractionServer

Wire up an InteractionServer that initializes an InvocationContext earlier than the cluster API supports.

This is necessary for attributes because the ClusterServer attribute APIs are synchronous while transaction management is asynchronous.

It's not necessary for command handling because that API is entirely async. We do it here, however, just for the sake of consistency.

This could be integrated directly into InteractionServer but this further refactoring is probably warranted there regardless. This keeps the touch light for now.

Hierarchy (view full)

InteractionServer
- TransactionalInteractionServer

Index

Constructors

constructor

new TransactionalInteractionServer(endpoint, context): TransactionalInteractionServer
Parameters
- endpoint: Endpoint<RootEndpoint>
- context: InteractionContext
Returns TransactionalInteractionServer
Overrides InteractionServer.constructor
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:87

Accessors

aclServer

get aclServer(): AccessControlServer
Returns AccessControlServer
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:140

`Protected`isClosing

get isClosing(): boolean
Returns boolean
Inherited from InteractionServer.isClosing
- Defined in packages/protocol/dist/esm/interaction/InteractionServer.d.ts:75

maxPathsPerInvoke

get maxPathsPerInvoke(): number
Returns number
Inherited from InteractionServer.maxPathsPerInvoke
- Defined in packages/protocol/dist/esm/interaction/InteractionServer.d.ts:76

Methods

[asyncDispose]

[asyncDispose](): Promise<void>
Returns Promise<void>
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:113

blockNewActivity

blockNewActivity(): void
Returns void
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:119

close

close(): Promise<void>
Returns Promise<void>
Inherited from InteractionServer.close
- Defined in packages/protocol/dist/esm/interaction/InteractionServer.d.ts:95

getId

getId(): number
Returns number
Inherited from InteractionServer.getId
- Defined in packages/protocol/dist/esm/interaction/InteractionServer.d.ts:74

handleInvokeRequest

handleInvokeRequest(exchange, __namedParameters, messenger, message): Promise<void>
Parameters
- exchange: MessageExchange
- __namedParameters: TypeFromFields<{
      interactionModelRevision: FieldType<number>;
      invokeRequests: FieldType<TypeFromFields<{
          commandFields: OptionalFieldType<TlvStream>;
          commandPath: FieldType<TypeFromFields<{
              clusterId: FieldType<ClusterId>;
              commandId: FieldType<CommandId>;
              endpointId: OptionalFieldType<EndpointNumber>;
          }>>;
          commandRef: OptionalFieldType<number>;
      }>[]>;
      suppressResponse: FieldType<boolean>;
      timedRequest: FieldType<boolean>;
  }>
- messenger: InteractionServerMessenger
- message: Message
Returns Promise<void>
Inherited from InteractionServer.handleInvokeRequest
- Defined in packages/protocol/dist/esm/interaction/InteractionServer.d.ts:87

handleReadRequest

handleReadRequest(exchange, __namedParameters, message): Promise<DataReportPayload>
Parameters
- exchange: MessageExchange
- __namedParameters: TypeFromFields<{
      attributeRequests: OptionalFieldType<TypeFromFields<{
          attributeId: OptionalFieldType<AttributeId>;
          clusterId: OptionalFieldType<ClusterId>;
          enableTagCompression: OptionalFieldType<boolean>;
          endpointId: OptionalFieldType<EndpointNumber>;
          listIndex: OptionalFieldType<null | number>;
          nodeId: OptionalFieldType<NodeId>;
          wildcardPathFlags: OptionalFieldType<TypeFromPartialBitSchema<{
              reserved1: BitFlag;
              skipAttributeList: BitFlag;
              skipChangesOmittedAttributes: BitFlag;
              skipCommandLists: BitFlag;
              skipCustomElements: BitFlag;
              skipDiagnosticsClusters: BitFlag;
              skipFixedAttributes: BitFlag;
              skipGlobalAttributes: BitFlag;
              skipRootNode: BitFlag;
          }>>;
      }>[]>;
      dataVersionFilters: OptionalFieldType<TypeFromFields<{
          dataVersion: FieldType<number>;
          path: FieldType<TypeFromFields<{
              clusterId: FieldType<ClusterId>;
              endpointId: FieldType<EndpointNumber>;
              nodeId: OptionalFieldType<NodeId>;
          }>>;
      }>[]>;
      eventFilters: OptionalFieldType<TypeFromFields<{
          eventMin: FieldType<number | bigint>;
          nodeId: OptionalFieldType<NodeId>;
      }>[]>;
      eventRequests: OptionalFieldType<TypeFromFields<{
          clusterId: OptionalFieldType<ClusterId>;
          endpointId: OptionalFieldType<EndpointNumber>;
          eventId: OptionalFieldType<EventId>;
          isUrgent: OptionalFieldType<boolean>;
          nodeId: OptionalFieldType<NodeId>;
      }>[]>;
      interactionModelRevision: FieldType<number>;
      isFabricFiltered: FieldType<boolean>;
  }>
- message: Message
Returns Promise<DataReportPayload>
Inherited from InteractionServer.handleReadRequest
- Defined in packages/protocol/dist/esm/interaction/InteractionServer.d.ts:78

handleSubscribeRequest

handleSubscribeRequest(exchange, __namedParameters, messenger, message): Promise<void>
Parameters
- exchange: MessageExchange
- __namedParameters: TypeFromFields<{
      attributeRequests: OptionalFieldType<TypeFromFields<{
          attributeId: OptionalFieldType<AttributeId>;
          clusterId: OptionalFieldType<ClusterId>;
          enableTagCompression: OptionalFieldType<boolean>;
          endpointId: OptionalFieldType<EndpointNumber>;
          listIndex: OptionalFieldType<null | number>;
          nodeId: OptionalFieldType<NodeId>;
          wildcardPathFlags: OptionalFieldType<TypeFromPartialBitSchema<{
              reserved1: BitFlag;
              skipAttributeList: BitFlag;
              skipChangesOmittedAttributes: BitFlag;
              skipCommandLists: BitFlag;
              skipCustomElements: BitFlag;
              skipDiagnosticsClusters: BitFlag;
              skipFixedAttributes: BitFlag;
              skipGlobalAttributes: BitFlag;
              skipRootNode: BitFlag;
          }>>;
      }>[]>;
      dataVersionFilters: OptionalFieldType<TypeFromFields<{
          dataVersion: FieldType<number>;
          path: FieldType<TypeFromFields<{
              clusterId: FieldType<ClusterId>;
              endpointId: FieldType<EndpointNumber>;
              nodeId: OptionalFieldType<NodeId>;
          }>>;
      }>[]>;
      eventFilters: OptionalFieldType<TypeFromFields<{
          eventMin: FieldType<number | bigint>;
          nodeId: OptionalFieldType<NodeId>;
      }>[]>;
      eventRequests: OptionalFieldType<TypeFromFields<{
          clusterId: OptionalFieldType<ClusterId>;
          endpointId: OptionalFieldType<EndpointNumber>;
          eventId: OptionalFieldType<EventId>;
          isUrgent: OptionalFieldType<boolean>;
          nodeId: OptionalFieldType<NodeId>;
      }>[]>;
      interactionModelRevision: FieldType<number>;
      isFabricFiltered: FieldType<boolean>;
      keepSubscriptions: FieldType<boolean>;
      maxIntervalCeilingSeconds: FieldType<number>;
      minIntervalFloorSeconds: FieldType<number>;
  }>
- messenger: InteractionServerMessenger
- message: Message
Returns Promise<void>
Inherited from InteractionServer.handleSubscribeRequest
- Defined in packages/protocol/dist/esm/interaction/InteractionServer.d.ts:86

handleTimedRequest

handleTimedRequest(exchange, __namedParameters): void
Parameters
- exchange: MessageExchange
- __namedParameters: TypeFromFields<{
  interactionModelRevision: FieldType<number>;
  timeout: FieldType<number>;
  }>
Returns void
Inherited from InteractionServer.handleTimedRequest
- Defined in packages/protocol/dist/esm/interaction/InteractionServer.d.ts:94

handleWriteRequest

handleWriteRequest(exchange, writeRequest, message): Promise<TypeFromFields<{
    interactionModelRevision: FieldType<number>;
    writeResponses: FieldType<TypeFromFields<{
        path: FieldType<TypeFromFields<{
            attributeId: OptionalFieldType<(...)>;
            clusterId: OptionalFieldType<(...)>;
            enableTagCompression: OptionalFieldType<(...)>;
            endpointId: OptionalFieldType<(...)>;
            listIndex: OptionalFieldType<(...)>;
            nodeId: OptionalFieldType<(...)>;
            wildcardPathFlags: OptionalFieldType<(...)>;
        }>>;
        status: FieldType<TypeFromFields<{
            clusterStatus: OptionalFieldType<(...)>;
            status: OptionalFieldType<(...)>;
        }>>;
    }>[]>;
}>>
Parameters
- exchange: MessageExchange
- writeRequest: TypeFromFields<{
      interactionModelRevision: FieldType<number>;
      moreChunkedMessages: OptionalFieldType<boolean>;
      suppressResponse: OptionalFieldType<boolean>;
      timedRequest: FieldType<boolean>;
      writeRequests: FieldType<TypeFromFields<{
          data: FieldType<TlvStream>;
          dataVersion: OptionalFieldType<number>;
          path: FieldType<TypeFromFields<{
              attributeId: OptionalFieldType<AttributeId>;
              clusterId: OptionalFieldType<ClusterId>;
              enableTagCompression: OptionalFieldType<boolean>;
              endpointId: OptionalFieldType<EndpointNumber>;
              listIndex: OptionalFieldType<(...) | (...)>;
              nodeId: OptionalFieldType<NodeId>;
              wildcardPathFlags: OptionalFieldType<TypeFromPartialBitSchema<(...)>>;
          }>>;
      }>[]>;
  }>
- message: Message
Returns Promise<TypeFromFields<{
    interactionModelRevision: FieldType<number>;
    writeResponses: FieldType<TypeFromFields<{
        path: FieldType<TypeFromFields<{
            attributeId: OptionalFieldType<(...)>;
            clusterId: OptionalFieldType<(...)>;
            enableTagCompression: OptionalFieldType<(...)>;
            endpointId: OptionalFieldType<(...)>;
            listIndex: OptionalFieldType<(...)>;
            nodeId: OptionalFieldType<(...)>;
            wildcardPathFlags: OptionalFieldType<(...)>;
        }>>;
        status: FieldType<TypeFromFields<{
            clusterStatus: OptionalFieldType<(...)>;
            status: OptionalFieldType<(...)>;
        }>>;
    }>[]>;
}>>
Overrides InteractionServer.handleWriteRequest
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:210

`Protected`invokeCommand

invokeCommand(path, command, exchange, commandFields, message, endpoint, timed?): Promise<{
    clusterCode?: number;
    code: Status;
    response: TlvStream;
    responseId: CommandId;
}>
Parameters
- path: CommandPath
- command: CommandServer<any, any>
- exchange: MessageExchange
- commandFields: any
- message: Message
- endpoint: EndpointInterface
- timed: boolean = false
Returns Promise<{
    clusterCode?: number;
    code: Status;
    response: TlvStream;
    responseId: CommandId;
}>
Overrides InteractionServer.invokeCommand
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:262

onNewExchange

onNewExchange(exchange): Promise<void>
Parameters
- exchange: MessageExchange
Returns Promise<void>
Overrides InteractionServer.onNewExchange
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:123

`Protected`readAttribute

readAttribute(path, attribute, exchange, fabricFiltered, message, endpoint, offline?): Promise<{
value: any;
version: number;
}>
Parameters
- path: AttributePath
- attribute: AnyAttributeServer<any>
- exchange: MessageExchange
- fabricFiltered: boolean
- message: Message
- endpoint: EndpointInterface
- offline: boolean = false
Returns Promise<{
value: any;
version: number;
}>
Overrides InteractionServer.readAttribute
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:151

`Protected`readEvent

readEvent(path, eventFilters, event, exchange, fabricFiltered, message, endpoint): Promise<EventStorageData<any>[]>
Parameters
- path: EventPath
- eventFilters: undefined | TypeFromFields<{
  eventMin: FieldType<number | bigint>;
  nodeId: OptionalFieldType<NodeId>;
  }>[]
- event: AnyEventServer<any, any>
- exchange: MessageExchange
- fabricFiltered: boolean
- message: Message
- endpoint: EndpointInterface
Returns Promise<EventStorageData<any>[]>
Overrides InteractionServer.readEvent
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:180

`Protected`writeAttribute

writeAttribute(path, attribute, value, exchange, message, endpoint, timed?, isListWrite?): Promise<void>
Parameters
- path: AttributePath
- attribute: AttributeServer<any>
- value: any
- exchange: MessageExchange
- message: Message
- endpoint: EndpointInterface
- timed: boolean = false
- OptionalisListWrite: boolean
Returns Promise<void>
Overrides InteractionServer.writeAttribute
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:225

`Static`create

create(endpoint, sessions): Promise<TransactionalInteractionServer>
Parameters
- endpoint: Endpoint<RootEndpoint>
- sessions: SessionManager
Returns Promise<TransactionalInteractionServer>
- Defined in packages/node/src/node/server/TransactionalInteractionServer.ts:74

Class TransactionalInteractionServer

Hierarchy (view full)

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns TransactionalInteractionServer

Accessors

aclServer

Returns AccessControlServer

ProtectedisClosing

Returns boolean

maxPathsPerInvoke

Returns number

Methods

[asyncDispose]

Returns Promise<void>

blockNewActivity

Returns void

close

Returns Promise<void>

getId

Returns number

handleInvokeRequest

Parameters

Returns Promise<void>

handleReadRequest

Parameters

Returns Promise<DataReportPayload>

handleSubscribeRequest

Parameters

Returns Promise<void>

handleTimedRequest

Parameters

Returns void

handleWriteRequest

Parameters

ProtectedinvokeCommand

Parameters

Returns Promise<{ clusterCode?: number; code: Status; response: TlvStream; responseId: CommandId; }>

onNewExchange

Parameters

Returns Promise<void>

ProtectedreadAttribute

Parameters

Returns Promise<{ value: any; version: number; }>

ProtectedreadEvent

Parameters

Returns Promise<EventStorageData<any>[]>

ProtectedwriteAttribute

Parameters

Returns Promise<void>

Staticcreate

Parameters

Returns Promise<TransactionalInteractionServer>

Settings

On This Page

`Protected`isClosing

`Protected`invokeCommand

Returns Promise<{
clusterCode?: number;
code: Status;
response: TlvStream;
responseId: CommandId;
}>

`Protected`readAttribute

Returns Promise<{
value: any;
version: number;
}>

`Protected`readEvent

`Protected`writeAttribute

`Static`create