Class SecureChannelMessenger

Hierarchy (view full)

SecureChannelMessenger

Index

Constructors

Properties

Methods

close getChannelName nextMessage nextMessageDecoded send sendCloseSession sendError sendSuccess throwIfErrorStatusReport waitForSuccess

Constructors

constructor

new SecureChannelMessenger(exchange, defaultExpectedProcessingTimeMs?): SecureChannelMessenger
Parameters
- exchange: MessageExchange
- defaultExpectedProcessingTimeMs: number = EXPECTED_CRYPTO_PROCESSING_TIME_MS
Returns SecureChannelMessenger
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:39

Properties

`Protected` `Readonly`exchange

exchange: MessageExchange

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:123

getChannelName

getChannelName(): string
Returns string
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:119

nextMessage

nextMessage(expectedMessageInfo, expectedMessageType?, expectedProcessingTimeMs?): Promise<Message>
Waits for the next message and returns it. When no expectedProcessingTimeMs is provided, the default value of EXPECTED_CRYPTO_PROCESSING_TIME_MS is used.
Parameters
- expectedMessageInfo: string
- OptionalexpectedMessageType: number
- expectedProcessingTimeMs: number = ...
Returns Promise<Message>
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:50

nextMessageDecoded

nextMessageDecoded<T>(expectedMessageType, schema, expectedMessageInfo, expectedProcessingTimeMs?): Promise<T>
Waits for the next message and decodes it. When no expectedProcessingTimeMs is provided, the default value of EXPECTED_CRYPTO_PROCESSING_TIME_MS is used.
Type Parameters
- T
Parameters
- expectedMessageType: number
- schema: TlvSchema<T>
- expectedMessageInfo: string
- expectedProcessingTimeMs: number = ...
Returns Promise<T>
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:69

send

send<T>(message, type, schema, options?): Promise<Uint8Array>
Sends a message of the given type with the given payload. If no ExchangeSendOptions are provided, the expectedProcessingTimeMs will be set to EXPECTED_CRYPTO_PROCESSING_TIME_MS.
Type Parameters
- T
Parameters
- message: T
- type: number
- schema: TlvSchema<T>
- Optionaloptions: ExchangeSendOptions
Returns Promise<Uint8Array>
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:97

sendCloseSession

sendCloseSession(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:115

sendError

sendError(code): Promise<void>
Parameters
- code: ProtocolStatusCode
Returns Promise<void>
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:107

sendSuccess

sendSuccess(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:111

`Protected`throwIfErrorStatusReport

throwIfErrorStatusReport(message, logHint?): void
Parameters
- message: Message
- OptionallogHint: string
Returns void
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:143

waitForSuccess

waitForSuccess(expectedMessageInfo, expectedProcessingTimeMs?): Promise<void>
Waits for the next message and returns it. When no expectedProcessingTimeMs is provided, the default value of EXPECTED_CRYPTO_PROCESSING_TIME_MS is used.
Parameters
- expectedMessageInfo: string
- expectedProcessingTimeMs: number = ...
Returns Promise<void>
- Defined in packages/protocol/src/securechannel/SecureChannelMessenger.ts:84

Class SecureChannelMessenger

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SecureChannelMessenger

Properties

Protected Readonlyexchange

Methods

close

Returns Promise<void>

getChannelName

Returns string

nextMessage

Parameters

Returns Promise<Message>

nextMessageDecoded

Type Parameters

Parameters

Returns Promise<T>

send

Type Parameters

Parameters

Returns Promise<Uint8Array>

sendCloseSession

Returns Promise<void>

sendError

Parameters

Returns Promise<void>

sendSuccess

Returns Promise<void>

ProtectedthrowIfErrorStatusReport

Parameters

Returns void

waitForSuccess

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`exchange

`Protected`throwIfErrorStatusReport