Class MessageExchange

constructor

• new MessageExchange(context, isInitiator, peerSessionId, nodeId, peerNodeId, exchangeId, protocolId): MessageExchange

• Parameters

  • context: MessageExchangeContext
  • isInitiator: boolean
  • peerSessionId: number
  • nodeId: undefined | NodeId
  • peerNodeId: undefined | NodeId
  • exchangeId: number
  • protocolId: number

  Returns MessageExchange

Readonlycontext

ReadonlyisInitiator

channel

• get channel(): MessageChannel

• Returns MessageChannel

closed

• get closed(): AsyncObservable<[], void>

• Returns AsyncObservable<[], void>

id

• get id(): number

• Returns number

isClosing

• get isClosing(): boolean

• Returns boolean

maxPayloadSize

• get maxPayloadSize(): number

• Max Payload size of the exchange which bases on the maximum payload size of the channel reduced by Matter protocol overhead.

  Returns number

session

• get session(): Session

• Returns Session

calculateMaximumPeerResponseTime

• calculateMaximumPeerResponseTime(expectedProcessingTimeMs?): number

• Parameters

  • OptionalexpectedProcessingTimeMs: number

  Returns number

clearTimedInteraction

• clearTimedInteraction(): void

• Returns void

close

• close(): Promise<void>

• Returns Promise<void>

destroy

• destroy(): Promise<void>

• Returns Promise<void>

hasActiveTimedInteraction

• hasActiveTimedInteraction(): boolean

• Returns boolean

hasExpiredTimedInteraction

• hasExpiredTimedInteraction(): boolean

• Returns boolean

hasTimedInteraction

• hasTimedInteraction(): boolean

• Returns boolean

nextMessage

• nextMessage(expectedProcessingTimeMs?): Promise<Message>

• Parameters

  • OptionalexpectedProcessingTimeMs: number

  Returns Promise<Message>

onMessageReceived

• onMessageReceived(message, isDuplicate?): Promise<void>

• Parameters

  • message: Message
  • OptionalisDuplicate: boolean

  Returns Promise<void>

send

• send(messageType, payload, options?): Promise<void>

• Parameters

  • messageType: number
  • payload: Uint8Array
  • Optionaloptions: ExchangeSendOptions

  Returns Promise<void>

sendStandaloneAckForMessage

• sendStandaloneAckForMessage(message): Promise<void>

• Parameters

  • message: Message

  Returns Promise<void>

startTimedInteraction

• startTimedInteraction(timeoutMs): void

• Parameters

  • timeoutMs: number

  Returns void

StaticfromInitialMessage

• fromInitialMessage(context, initialMessage): MessageExchange

• Parameters

  • context: MessageExchangeContext
  • initialMessage: Message

  Returns MessageExchange

Staticinitiate

• initiate(context, exchangeId, protocolId): MessageExchange

• Parameters

  • context: MessageExchangeContext
  • exchangeId: number
  • protocolId: number

  Returns MessageExchange