Class InteractionServerMessenger

Hierarchy

InteractionMessenger
- InteractionServerMessenger

Index

Constructors

Properties

Methods

calculateMaximumPeerResponseTime close getExchangeChannelName handleRequest nextMessage send sendDataReport sendDataReportMessage sendStatus throwIfErrorStatusMessage waitForSuccess

Constructors

constructor

new InteractionServerMessenger(exchange): InteractionServerMessenger
Parameters
- exchange: MessageExchange
Returns InteractionServerMessenger
Inherited from InteractionMessenger.constructor
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:74

Properties

`Protected`exchange

exchange: MessageExchange

Methods

calculateMaximumPeerResponseTime

calculateMaximumPeerResponseTime(expectedProcessingTimeMs?): number
Parameters
- OptionalexpectedProcessingTimeMs: number
Returns number
Inherited from InteractionMessenger.calculateMaximumPeerResponseTime
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:76

close

close(): Promise<void>
Returns Promise<void>
Inherited from InteractionMessenger.close
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:108

getExchangeChannelName

getExchangeChannelName(): string
Returns string
Inherited from InteractionMessenger.getExchangeChannelName
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:123

handleRequest

handleRequest(recipient): Promise<void>
Parameters
- recipient: InteractionRecipient
Returns Promise<void>
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:147

nextMessage

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

send

send(messageType, payload, options?): Promise<void>
Parameters
- messageType: number
- payload: Uint8Array
- Optionaloptions: ExchangeSendOptions
Returns Promise<void>
Inherited from InteractionMessenger.send
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:80

sendDataReport

sendDataReport(dataReportPayload, forFabricFilteredRead): Promise<void>
Handle DataReportPayload with the content of a DataReport to send, split them into multiple DataReport messages and send them out based on the size.
Parameters
- dataReportPayload: DataReportPayload
- forFabricFilteredRead: boolean
Returns Promise<void>
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:228

sendDataReportMessage

sendDataReportMessage(dataReport): Promise<void>
Parameters
- dataReport: TypeFromFields<{
      attributeReports: OptionalFieldType<TlvStream[]>;
      eventReports: OptionalFieldType<TlvStream[]>;
      interactionModelRevision: FieldType<number>;
      moreChunkedMessages: OptionalFieldType<boolean>;
      subscriptionId: OptionalFieldType<number>;
      suppressResponse: OptionalFieldType<boolean>;
  }>
Returns Promise<void>
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:326

sendStatus

sendStatus(status): Promise<void>
Parameters
- status: Status
Returns Promise<void>
Inherited from InteractionMessenger.sendStatus
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:84

`Protected`throwIfErrorStatusMessage

throwIfErrorStatusMessage(message): void
Parameters
- message: Message
Returns void
Inherited from InteractionMessenger.throwIfErrorStatusMessage
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:112

waitForSuccess

waitForSuccess(expectedProcessingTimeMs?): Promise<void>
Parameters
- OptionalexpectedProcessingTimeMs: number
Returns Promise<void>
Inherited from InteractionMessenger.waitForSuccess
- Defined in packages/protocol/src/interaction/InteractionMessenger.ts:91

Class InteractionServerMessenger

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns InteractionServerMessenger

Properties

Protectedexchange

Methods

calculateMaximumPeerResponseTime

Parameters

Returns number

close

Returns Promise<void>

getExchangeChannelName

Returns string

handleRequest

Parameters

Returns Promise<void>

nextMessage

Parameters

Returns Promise<Message>

send

Parameters

Returns Promise<void>

sendDataReport

Parameters

Returns Promise<void>

sendDataReportMessage

Parameters

Returns Promise<void>

sendStatus

Parameters

Returns Promise<void>

ProtectedthrowIfErrorStatusMessage

Parameters

Returns void

waitForSuccess

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`exchange

`Protected`throwIfErrorStatusMessage