Class InteractionClientMessenger

Hierarchy (view full)

IncomingInteractionClientMessenger
- InteractionClientMessenger

Index

Constructors

Properties

Methods

calculateMaximumPeerResponseTime close getExchangeChannelName nextMessage readDataReports send sendInvokeCommand sendReadRequest sendStatus sendSubscribeRequest sendTimedRequest sendWriteCommand throwIfErrorStatusMessage waitFor waitForSuccess create

Constructors

constructor

new InteractionClientMessenger(exchange, exchangeProvider): InteractionClientMessenger
Parameters
- exchange: MessageExchange
- exchangeProvider: ExchangeProvider
Returns InteractionClientMessenger
Overrides IncomingInteractionClientMessenger.constructor
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:68

Properties

`Protected`exchange

exchange: MessageExchange

Methods

calculateMaximumPeerResponseTime

calculateMaximumPeerResponseTime(expectedProcessingTimeMs?): number
Parameters
- OptionalexpectedProcessingTimeMs: number
Returns number
Inherited from IncomingInteractionClientMessenger.calculateMaximumPeerResponseTime
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:35

close

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

getExchangeChannelName

getExchangeChannelName(): string
Returns string
Inherited from IncomingInteractionClientMessenger.getExchangeChannelName
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:42

nextMessage

nextMessage(expectedMessageType?, expectedProcessingTimeMs?): Promise<Message>
Parameters
- OptionalexpectedMessageType: number
- OptionalexpectedProcessingTimeMs: number
Returns Promise<Message>
Inherited from IncomingInteractionClientMessenger.nextMessage
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:39

readDataReports

readDataReports(expectedSubscriptionIds?): Promise<TypeFromFields<{
    attributeReports: OptionalFieldType<TypeFromFields<{
        attributeData: OptionalFieldType<TypeFromFields<{
            data: FieldType<(...)>;
            dataVersion: OptionalFieldType<(...)>;
            path: FieldType<(...)>;
        }>>;
        attributeStatus: OptionalFieldType<TypeFromFields<{
            path: FieldType<(...)>;
            status: FieldType<(...)>;
        }>>;
    }>[]>;
    eventReports: OptionalFieldType<TypeFromFields<{
        eventData: OptionalFieldType<TypeFromFields<{
            data: OptionalFieldType<(...)>;
            deltaEpochTimestamp: OptionalFieldType<(...)>;
            deltaSystemTimestamp: OptionalFieldType<(...)>;
            epochTimestamp: OptionalFieldType<(...)>;
            eventNumber: FieldType<(...)>;
            path: FieldType<(...)>;
            priority: FieldType<(...)>;
            systemTimestamp: OptionalFieldType<(...)>;
        }>>;
        eventStatus: OptionalFieldType<TypeFromFields<{
            path: FieldType<(...)>;
            status: FieldType<(...)>;
        }>>;
    }>[]>;
    interactionModelRevision: FieldType<number>;
    moreChunkedMessages: OptionalFieldType<boolean>;
    subscriptionId: OptionalFieldType<number>;
    suppressResponse: OptionalFieldType<boolean>;
}>>
Parameters
- OptionalexpectedSubscriptionIds: number[]
Returns Promise<TypeFromFields<{
    attributeReports: OptionalFieldType<TypeFromFields<{
        attributeData: OptionalFieldType<TypeFromFields<{
            data: FieldType<(...)>;
            dataVersion: OptionalFieldType<(...)>;
            path: FieldType<(...)>;
        }>>;
        attributeStatus: OptionalFieldType<TypeFromFields<{
            path: FieldType<(...)>;
            status: FieldType<(...)>;
        }>>;
    }>[]>;
    eventReports: OptionalFieldType<TypeFromFields<{
        eventData: OptionalFieldType<TypeFromFields<{
            data: OptionalFieldType<(...)>;
            deltaEpochTimestamp: OptionalFieldType<(...)>;
            deltaSystemTimestamp: OptionalFieldType<(...)>;
            epochTimestamp: OptionalFieldType<(...)>;
            eventNumber: FieldType<(...)>;
            path: FieldType<(...)>;
            priority: FieldType<(...)>;
            systemTimestamp: OptionalFieldType<(...)>;
        }>>;
        eventStatus: OptionalFieldType<TypeFromFields<{
            path: FieldType<(...)>;
            status: FieldType<(...)>;
        }>>;
    }>[]>;
    interactionModelRevision: FieldType<number>;
    moreChunkedMessages: OptionalFieldType<boolean>;
    subscriptionId: OptionalFieldType<number>;
    suppressResponse: OptionalFieldType<boolean>;
}>>
Inherited from IncomingInteractionClientMessenger.readDataReports
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:62

send

send(messageType, payload, options?): Promise<void>
Implements a send method with an automatic reconnection mechanism
Parameters
- messageType: number
- payload: Uint8Array
- Optionaloptions: ExchangeSendOptions
Returns Promise<void>
Overrides IncomingInteractionClientMessenger.send
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:70

sendInvokeCommand

sendInvokeCommand(invokeRequest, expectedProcessingTimeMs?): Promise<undefined | TypeFromFields<{
    interactionModelRevision: FieldType<number>;
    invokeResponses: FieldType<TypeFromFields<{
        command: OptionalFieldType<TypeFromFields<{
            commandFields: ...;
            commandPath: ...;
            commandRef: ...;
        }>>;
        status: OptionalFieldType<TypeFromFields<{
            commandPath: ...;
            commandRef: ...;
            status: ...;
        }>>;
    }>[]>;
    moreChunkedMessages: OptionalFieldType<boolean>;
    suppressResponse: FieldType<boolean>;
}>>
Parameters
- invokeRequest: 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>;
  }>
- OptionalexpectedProcessingTimeMs: number
Returns Promise<undefined | TypeFromFields<{
    interactionModelRevision: FieldType<number>;
    invokeResponses: FieldType<TypeFromFields<{
        command: OptionalFieldType<TypeFromFields<{
            commandFields: ...;
            commandPath: ...;
            commandRef: ...;
        }>>;
        status: OptionalFieldType<TypeFromFields<{
            commandPath: ...;
            commandRef: ...;
            status: ...;
        }>>;
    }>[]>;
    moreChunkedMessages: OptionalFieldType<boolean>;
    suppressResponse: FieldType<boolean>;
}>>
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:252

sendReadRequest

sendReadRequest(readRequest): Promise<TypeFromFields<{
    attributeReports: OptionalFieldType<TypeFromFields<{
        attributeData: OptionalFieldType<TypeFromFields<{
            data: FieldType<(...)>;
            dataVersion: OptionalFieldType<(...)>;
            path: FieldType<(...)>;
        }>>;
        attributeStatus: OptionalFieldType<TypeFromFields<{
            path: FieldType<(...)>;
            status: FieldType<(...)>;
        }>>;
    }>[]>;
    eventReports: OptionalFieldType<TypeFromFields<{
        eventData: OptionalFieldType<TypeFromFields<{
            data: OptionalFieldType<(...)>;
            deltaEpochTimestamp: OptionalFieldType<(...)>;
            deltaSystemTimestamp: OptionalFieldType<(...)>;
            epochTimestamp: OptionalFieldType<(...)>;
            eventNumber: FieldType<(...)>;
            path: FieldType<(...)>;
            priority: FieldType<(...)>;
            systemTimestamp: OptionalFieldType<(...)>;
        }>>;
        eventStatus: OptionalFieldType<TypeFromFields<{
            path: FieldType<(...)>;
            status: FieldType<(...)>;
        }>>;
    }>[]>;
    interactionModelRevision: FieldType<number>;
    moreChunkedMessages: OptionalFieldType<boolean>;
    subscriptionId: OptionalFieldType<number>;
    suppressResponse: OptionalFieldType<boolean>;
}>>
Parameters
- readRequest: 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>;
  }>
Returns Promise<TypeFromFields<{
    attributeReports: OptionalFieldType<TypeFromFields<{
        attributeData: OptionalFieldType<TypeFromFields<{
            data: FieldType<(...)>;
            dataVersion: OptionalFieldType<(...)>;
            path: FieldType<(...)>;
        }>>;
        attributeStatus: OptionalFieldType<TypeFromFields<{
            path: FieldType<(...)>;
            status: FieldType<(...)>;
        }>>;
    }>[]>;
    eventReports: OptionalFieldType<TypeFromFields<{
        eventData: OptionalFieldType<TypeFromFields<{
            data: OptionalFieldType<(...)>;
            deltaEpochTimestamp: OptionalFieldType<(...)>;
            deltaSystemTimestamp: OptionalFieldType<(...)>;
            epochTimestamp: OptionalFieldType<(...)>;
            eventNumber: FieldType<(...)>;
            path: FieldType<(...)>;
            priority: FieldType<(...)>;
            systemTimestamp: OptionalFieldType<(...)>;
        }>>;
        eventStatus: OptionalFieldType<TypeFromFields<{
            path: FieldType<(...)>;
            status: FieldType<(...)>;
        }>>;
    }>[]>;
    interactionModelRevision: FieldType<number>;
    moreChunkedMessages: OptionalFieldType<boolean>;
    subscriptionId: OptionalFieldType<number>;
    suppressResponse: OptionalFieldType<boolean>;
}>>
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:71

sendStatus

sendStatus(status): Promise<void>
Parameters
- status: Status
Returns Promise<void>
Inherited from IncomingInteractionClientMessenger.sendStatus
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:37

sendSubscribeRequest

sendSubscribeRequest(subscribeRequest): Promise<{
    report: TypeFromFields<{
        attributeReports: OptionalFieldType<TypeFromFields<{
            attributeData: OptionalFieldType<TypeFromFields<{
                data: ...;
                dataVersion: ...;
                path: ...;
            }>>;
            attributeStatus: OptionalFieldType<TypeFromFields<{
                path: ...;
                status: ...;
            }>>;
        }>[]>;
        eventReports: OptionalFieldType<TypeFromFields<{
            eventData: OptionalFieldType<TypeFromFields<{
                data: ...;
                deltaEpochTimestamp: ...;
                deltaSystemTimestamp: ...;
                epochTimestamp: ...;
                eventNumber: ...;
                path: ...;
                priority: ...;
                systemTimestamp: ...;
            }>>;
            eventStatus: OptionalFieldType<TypeFromFields<{
                path: ...;
                status: ...;
            }>>;
        }>[]>;
        interactionModelRevision: FieldType<number>;
        moreChunkedMessages: OptionalFieldType<boolean>;
        subscriptionId: OptionalFieldType<number>;
        suppressResponse: OptionalFieldType<boolean>;
    }>;
    subscribeResponse: TypeFromFields<{
        interactionModelRevision: FieldType<number>;
        maxInterval: FieldType<number>;
        subscriptionId: FieldType<number>;
    }>;
}>
Parameters
- subscribeRequest: 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>;
  }>
Returns Promise<{
    report: TypeFromFields<{
        attributeReports: OptionalFieldType<TypeFromFields<{
            attributeData: OptionalFieldType<TypeFromFields<{
                data: ...;
                dataVersion: ...;
                path: ...;
            }>>;
            attributeStatus: OptionalFieldType<TypeFromFields<{
                path: ...;
                status: ...;
            }>>;
        }>[]>;
        eventReports: OptionalFieldType<TypeFromFields<{
            eventData: OptionalFieldType<TypeFromFields<{
                data: ...;
                deltaEpochTimestamp: ...;
                deltaSystemTimestamp: ...;
                epochTimestamp: ...;
                eventNumber: ...;
                path: ...;
                priority: ...;
                systemTimestamp: ...;
            }>>;
            eventStatus: OptionalFieldType<TypeFromFields<{
                path: ...;
                status: ...;
            }>>;
        }>[]>;
        interactionModelRevision: FieldType<number>;
        moreChunkedMessages: OptionalFieldType<boolean>;
        subscriptionId: OptionalFieldType<number>;
        suppressResponse: OptionalFieldType<boolean>;
    }>;
    subscribeResponse: TypeFromFields<{
        interactionModelRevision: FieldType<number>;
        maxInterval: FieldType<number>;
        subscriptionId: FieldType<number>;
    }>;
}>
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:158

sendTimedRequest

sendTimedRequest(timeoutSeconds): Promise<TypeFromFields<{
interactionModelRevision: FieldType<number>;
status: FieldType<Status>;
}>>
Parameters
- timeoutSeconds: number
Returns Promise<TypeFromFields<{
interactionModelRevision: FieldType<number>;
status: FieldType<Status>;
}>>
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:308

sendWriteCommand

sendWriteCommand(writeRequest): Promise<undefined | TypeFromFields<{
    interactionModelRevision: FieldType<number>;
    writeResponses: FieldType<TypeFromFields<{
        path: FieldType<TypeFromFields<{
            attributeId: ...;
            clusterId: ...;
            enableTagCompression: ...;
            endpointId: ...;
            listIndex: ...;
            nodeId: ...;
            wildcardPathFlags: ...;
        }>>;
        status: FieldType<TypeFromFields<{
            clusterStatus: ...;
            status: ...;
        }>>;
    }>[]>;
}>>
Parameters
- 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<(...)>>;
          }>>;
      }>[]>;
  }>
Returns Promise<undefined | TypeFromFields<{
    interactionModelRevision: FieldType<number>;
    writeResponses: FieldType<TypeFromFields<{
        path: FieldType<TypeFromFields<{
            attributeId: ...;
            clusterId: ...;
            enableTagCompression: ...;
            endpointId: ...;
            listIndex: ...;
            nodeId: ...;
            wildcardPathFlags: ...;
        }>>;
        status: FieldType<TypeFromFields<{
            clusterStatus: ...;
            status: ...;
        }>>;
    }>[]>;
}>>
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:280

`Protected`throwIfErrorStatusMessage

throwIfErrorStatusMessage(message): void
Parameters
- message: Message
Returns void
Inherited from IncomingInteractionClientMessenger.throwIfErrorStatusMessage
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:41

waitFor

waitFor(messageType, timeoutMs?): Promise<Message>
Parameters
- messageType: number
- OptionaltimeoutMs: number
Returns Promise<Message>
Inherited from IncomingInteractionClientMessenger.waitFor
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:61

waitForSuccess

waitForSuccess(expectedProcessingTimeMs?): Promise<void>
Parameters
- OptionalexpectedProcessingTimeMs: number
Returns Promise<void>
Inherited from IncomingInteractionClientMessenger.waitForSuccess
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:38

`Static`create

create(exchangeProvider): Promise<InteractionClientMessenger>
Parameters
- exchangeProvider: ExchangeProvider
Returns Promise<InteractionClientMessenger>
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:67

Class InteractionClientMessenger

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InteractionClientMessenger

Properties

Protectedexchange

Methods

calculateMaximumPeerResponseTime

Parameters

Returns number

close

Returns Promise<void>

getExchangeChannelName

Returns string

nextMessage

Parameters

Returns Promise<Message>

readDataReports

Parameters

send

Parameters

Returns Promise<void>

sendInvokeCommand

Parameters

sendReadRequest

Parameters

sendStatus

Parameters

Returns Promise<void>

sendSubscribeRequest

Parameters

sendTimedRequest

Parameters

Returns Promise<TypeFromFields<{ interactionModelRevision: FieldType<number>; status: FieldType<Status>; }>>

sendWriteCommand

Parameters

ProtectedthrowIfErrorStatusMessage

Parameters

Returns void

waitFor

Parameters

Returns Promise<Message>

waitForSuccess

Parameters

Returns Promise<void>

Staticcreate

Parameters

Returns Promise<InteractionClientMessenger>

Settings

On This Page

`Protected`exchange

Returns Promise<TypeFromFields<{
interactionModelRevision: FieldType<number>;
status: FieldType<Status>;
}>>

`Protected`throwIfErrorStatusMessage

`Static`create