Class CaseServerMessenger

Hierarchy (view full)

SecureChannelMessenger
- CaseServerMessenger

Index

Constructors

Properties

Methods

close getChannelName nextMessage nextMessageDecoded readSigma1 readSigma3 send sendCloseSession sendError sendSigma2 sendSigma2Resume sendSuccess throwIfErrorStatusReport waitForSuccess

Constructors

constructor

new CaseServerMessenger(exchange, defaultExpectedProcessingTimeMs?): CaseServerMessenger
Parameters
- exchange: MessageExchange
- OptionaldefaultExpectedProcessingTimeMs: number
Returns CaseServerMessenger
Inherited from SecureChannelMessenger.constructor
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:23

Properties

`Protected` `Readonly`exchange

exchange: MessageExchange

Methods

close

close(): Promise<void>
Returns Promise<void>
Inherited from SecureChannelMessenger.close
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:49

getChannelName

getChannelName(): string
Returns string
Inherited from SecureChannelMessenger.getChannelName
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:48

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
- OptionalexpectedProcessingTimeMs: number
Returns Promise<Message>
Inherited from SecureChannelMessenger.nextMessage
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:28

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
- OptionalexpectedProcessingTimeMs: number
Returns Promise<T>
Inherited from SecureChannelMessenger.nextMessageDecoded
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:33

readSigma1

readSigma1(): Promise<{
    sigma1: TypeFromFields<{
        destinationId: FieldType<Uint8Array>;
        initiatorEcdhPublicKey: FieldType<Uint8Array>;
        initiatorRandom: FieldType<Uint8Array>;
        initiatorResumeMic: OptionalFieldType<Uint8Array>;
        initiatorSessionId: FieldType<number>;
        initiatorSessionParams: OptionalFieldType<TypeFromFields<{
            activeIntervalMs: OptionalFieldType<number>;
            activeThresholdMs: OptionalFieldType<number>;
            dataModelRevision: OptionalFieldType<number>;
            idleIntervalMs: OptionalFieldType<number>;
            interactionModelRevision: OptionalFieldType<number>;
            maxPathsPerInvoke: OptionalFieldType<number>;
            specificationVersion: OptionalFieldType<number>;
        }>>;
        resumptionId: OptionalFieldType<Uint8Array>;
    }>;
    sigma1Bytes: Uint8Array;
}>
Returns Promise<{
    sigma1: TypeFromFields<{
        destinationId: FieldType<Uint8Array>;
        initiatorEcdhPublicKey: FieldType<Uint8Array>;
        initiatorRandom: FieldType<Uint8Array>;
        initiatorResumeMic: OptionalFieldType<Uint8Array>;
        initiatorSessionId: FieldType<number>;
        initiatorSessionParams: OptionalFieldType<TypeFromFields<{
            activeIntervalMs: OptionalFieldType<number>;
            activeThresholdMs: OptionalFieldType<number>;
            dataModelRevision: OptionalFieldType<number>;
            idleIntervalMs: OptionalFieldType<number>;
            interactionModelRevision: OptionalFieldType<number>;
            maxPathsPerInvoke: OptionalFieldType<number>;
            specificationVersion: OptionalFieldType<number>;
        }>>;
        resumptionId: OptionalFieldType<Uint8Array>;
    }>;
    sigma1Bytes: Uint8Array;
}>
- Defined in packages/protocol/dist/esm/session/case/CaseMessenger.d.ts:10

readSigma3

readSigma3(): Promise<{
    sigma3: TypeFromFields<{
        encrypted: FieldType<Uint8Array>;
    }>;
    sigma3Bytes: Uint8Array;
}>
Returns Promise<{
    sigma3: TypeFromFields<{
        encrypted: FieldType<Uint8Array>;
    }>;
    sigma3Bytes: Uint8Array;
}>
- Defined in packages/protocol/dist/esm/session/case/CaseMessenger.d.ts:32

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>
Inherited from SecureChannelMessenger.send
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:44

sendCloseSession

sendCloseSession(): Promise<void>
Returns Promise<void>
Inherited from SecureChannelMessenger.sendCloseSession
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:47

sendError

sendError(code): Promise<void>
Parameters
- code: ProtocolStatusCode
Returns Promise<void>
Inherited from SecureChannelMessenger.sendError
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:45

sendSigma2

sendSigma2(sigma2): Promise<Uint8Array>
Parameters
- sigma2: TypeFromFields<{
      encrypted: FieldType<Uint8Array>;
      responderEcdhPublicKey: FieldType<Uint8Array>;
      responderRandom: FieldType<Uint8Array>;
      responderSessionId: FieldType<number>;
      responderSessionParams: OptionalFieldType<TypeFromFields<{
          activeIntervalMs: OptionalFieldType<number>;
          activeThresholdMs: OptionalFieldType<number>;
          dataModelRevision: OptionalFieldType<number>;
          idleIntervalMs: OptionalFieldType<number>;
          interactionModelRevision: OptionalFieldType<number>;
          maxPathsPerInvoke: OptionalFieldType<number>;
          specificationVersion: OptionalFieldType<number>;
      }>>;
  }>
Returns Promise<Uint8Array>
- Defined in packages/protocol/dist/esm/session/case/CaseMessenger.d.ts:30

sendSigma2Resume

sendSigma2Resume(sigma2Resume): Promise<Uint8Array>
Parameters
- sigma2Resume: TypeFromFields<{
      responderSessionId: FieldType<number>;
      responderSessionParams: OptionalFieldType<TypeFromFields<{
          activeIntervalMs: OptionalFieldType<number>;
          activeThresholdMs: OptionalFieldType<number>;
          dataModelRevision: OptionalFieldType<number>;
          idleIntervalMs: OptionalFieldType<number>;
          interactionModelRevision: OptionalFieldType<number>;
          maxPathsPerInvoke: OptionalFieldType<number>;
          specificationVersion: OptionalFieldType<number>;
      }>>;
      resumeMic: FieldType<Uint8Array>;
      resumptionId: FieldType<Uint8Array>;
  }>
Returns Promise<Uint8Array>
- Defined in packages/protocol/dist/esm/session/case/CaseMessenger.d.ts:31

sendSuccess

sendSuccess(): Promise<void>
Returns Promise<void>
Inherited from SecureChannelMessenger.sendSuccess
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:46

`Protected`throwIfErrorStatusReport

throwIfErrorStatusReport(message, logHint?): void
Parameters
- message: Message
- OptionallogHint: string
Returns void
Inherited from SecureChannelMessenger.throwIfErrorStatusReport
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:51

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
- OptionalexpectedProcessingTimeMs: number
Returns Promise<void>
Inherited from SecureChannelMessenger.waitForSuccess
- Defined in packages/protocol/dist/esm/securechannel/SecureChannelMessenger.d.ts:38

Class CaseServerMessenger

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CaseServerMessenger

Properties

Protected Readonlyexchange

Methods

close

Returns Promise<void>

getChannelName

Returns string

nextMessage

Parameters

Returns Promise<Message>

nextMessageDecoded

Type Parameters

Parameters

Returns Promise<T>

readSigma1

readSigma3

Returns Promise<{ sigma3: TypeFromFields<{ encrypted: FieldType<Uint8Array>; }>; sigma3Bytes: Uint8Array; }>

send

Type Parameters

Parameters

Returns Promise<Uint8Array>

sendCloseSession

Returns Promise<void>

sendError

Parameters

Returns Promise<void>

sendSigma2

Parameters

Returns Promise<Uint8Array>

sendSigma2Resume

Parameters

Returns Promise<Uint8Array>

sendSuccess

Returns Promise<void>

ProtectedthrowIfErrorStatusReport

Parameters

Returns void

waitForSuccess

Parameters

Returns Promise<void>

Settings

On This Page

`Protected` `Readonly`exchange

Returns Promise<{
sigma3: TypeFromFields<{
encrypted: FieldType<Uint8Array>;
}>;
sigma3Bytes: Uint8Array;
}>

`Protected`throwIfErrorStatusReport