Class IncomingInteractionClientMessenger

Hierarchy (view full)

InteractionMessenger
- IncomingInteractionClientMessenger
  - InteractionClientMessenger

Index

Constructors

Properties

Methods

calculateMaximumPeerResponseTime close getExchangeChannelName nextMessage readDataReports send sendStatus throwIfErrorStatusMessage waitFor waitForSuccess

Constructors

constructor

new IncomingInteractionClientMessenger(exchange): IncomingInteractionClientMessenger
Parameters
- exchange: MessageExchange
Returns IncomingInteractionClientMessenger
Inherited from InteractionMessenger.constructor
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:34

Properties

`Protected`exchange

exchange: MessageExchange

Methods

calculateMaximumPeerResponseTime

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

close

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

getExchangeChannelName

getExchangeChannelName(): string
Returns string
Inherited from InteractionMessenger.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 InteractionMessenger.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>;
}>>
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:62

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/dist/esm/interaction/InteractionMessenger.d.ts:36

sendStatus

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

`Protected`throwIfErrorStatusMessage

throwIfErrorStatusMessage(message): void
Parameters
- message: Message
Returns void
Inherited from InteractionMessenger.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>
- Defined in packages/protocol/dist/esm/interaction/InteractionMessenger.d.ts:61

waitForSuccess

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

Class IncomingInteractionClientMessenger

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IncomingInteractionClientMessenger

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>

sendStatus

Parameters

Returns Promise<void>

ProtectedthrowIfErrorStatusMessage

Parameters

Returns void

waitFor

Parameters

Returns Promise<Message>

waitForSuccess

Parameters

Returns Promise<void>

Settings

On This Page

`Protected`exchange

`Protected`throwIfErrorStatusMessage