Class SecureSession

Hierarchy (view full)

Constructors

constructor

Properties

activeIntervalMs activeThresholdMs activeTimestamp closer? dataModelRevision idleIntervalMs interactionModelRevision maxPathsPerInvoke messageCounter messageReceptionState specificationVersion supportsMRP timestamp

Accessors

associatedFabric attestationChallengeKey caseAuthenticatedTags closingAfterExchangeFinished fabric id isClosing isPase isSecure manager name nodeId owner parameters peerAddress peerNodeId peerSessionId sendCloseMessageWhenClosing subscriptions

Methods

addAssociatedFabric clearSubscriptions close decode destroy encode end getIncrementedMessageCounter isPeerActive notifyActivity peerIs updateMessageCounter create

Constructors

constructor

  • new SecureSession(args): SecureSession

  • Parameters

    • args: {
          attestationKey: Uint8Array;
          caseAuthenticatedTags?: CaseAuthenticatedTag[];
          decryptKey: Uint8Array;
          encryptKey: Uint8Array;
          fabric: undefined | Fabric;
          id: number;
          isInitiator: boolean;
          manager?: SessionManager;
          peerNodeId: NodeId;
          peerSessionId: number;
          sessionParameters?: Partial<SessionParameters>;
      }

    Returns SecureSession

Properties

Protected ReadonlyactiveIntervalMs

activeIntervalMs: number

Protected ReadonlyactiveThresholdMs

activeThresholdMs: number

activeTimestamp

activeTimestamp: number

Optionalcloser

closer?: Promise<void>

If the ExchangeManager performs async work to clean up a session it sets this promise. This is because historically we didn't return from destroy() until ExchangeManager was complete. Not sure if this is entirely necessary but it makes sense so this allows us to maintain the old behavior.

Protected ReadonlydataModelRevision

dataModelRevision: number

Protected ReadonlyidleIntervalMs

idleIntervalMs: number

Protected ReadonlyinteractionModelRevision

interactionModelRevision: number

Protected ReadonlymaxPathsPerInvoke

maxPathsPerInvoke: number

Protected ReadonlymessageCounter

messageCounter: MessageCounter

Protected ReadonlymessageReceptionState

messageReceptionState: MessageReceptionState

Protected ReadonlyspecificationVersion

specificationVersion: number

ReadonlysupportsMRP

supportsMRP = true

timestamp

timestamp: number

Accessors

associatedFabric

  • get associatedFabric(): Fabric

  • Returns Fabric

attestationChallengeKey

  • get attestationChallengeKey(): Uint8Array

  • Returns Uint8Array

caseAuthenticatedTags

closingAfterExchangeFinished

  • get closingAfterExchangeFinished(): boolean

  • Returns boolean

fabric

  • get fabric(): undefined | Fabric

  • Returns undefined | Fabric

id

  • get id(): number

  • Returns number

isClosing

  • get isClosing(): boolean

  • Returns boolean

isPase

  • get isPase(): boolean

  • Returns boolean

isSecure

  • get isSecure(): boolean

  • Returns boolean

Protectedmanager

  • get manager(): undefined | SessionManager

  • Returns undefined | SessionManager

name

  • get name(): string

  • Returns string

nodeId

  • get nodeId(): NodeId

  • Returns NodeId

owner

  • get owner(): unknown

  • Returns unknown

    Deprecated

parameters

  • get parameters(): SessionParameters

  • The peer's session parameters.

    Returns SessionParameters

peerAddress

  • get peerAddress(): PeerAddress

  • The peer node's address.

    Returns PeerAddress

peerNodeId

  • get peerNodeId(): NodeId

  • Returns NodeId

peerSessionId

  • get peerSessionId(): number

  • Returns number

sendCloseMessageWhenClosing

  • get sendCloseMessageWhenClosing(): boolean

  • Returns boolean

subscriptions

Methods

addAssociatedFabric

  • addAssociatedFabric(fabric): void

  • Parameters

    Returns void

clearSubscriptions

  • clearSubscriptions(flushSubscriptions?): Promise<void>

  • Parameters

    • OptionalflushSubscriptions: boolean

    Returns Promise<void>

close

  • close(closeAfterExchangeFinished?): Promise<void>

  • Parameters

    • OptionalcloseAfterExchangeFinished: boolean

    Returns Promise<void>

decode

destroy

  • destroy(sendClose?, closeAfterExchangeFinished?): Promise<void>

  • Destroys a session. Outstanding subscription data will be discarded.

    Parameters

    • OptionalsendClose: boolean
    • OptionalcloseAfterExchangeFinished: boolean

    Returns Promise<void>

encode

end

  • end(sendClose, closeAfterExchangeFinished?): Promise<void>

  • Ends a session. Outstanding subscription data will be flushed before the session is destroyed.

    Parameters

    • sendClose: boolean
    • OptionalcloseAfterExchangeFinished: boolean

    Returns Promise<void>

getIncrementedMessageCounter

  • getIncrementedMessageCounter(): Promise<number>

  • Returns Promise<number>

isPeerActive

  • isPeerActive(): boolean

  • Returns boolean

notifyActivity

  • notifyActivity(messageReceived): void

  • Parameters

    • messageReceived: boolean

    Returns void

peerIs

  • peerIs(address): boolean

  • Indicates whether a peer matches a specific address.

    Parameters

    Returns boolean

updateMessageCounter

  • updateMessageCounter(messageCounter, _sourceNodeId?): void

  • Parameters

    • messageCounter: number
    • Optional_sourceNodeId: NodeId

    Returns void

Staticcreate

  • create(args): Promise<SecureSession>

  • Parameters

    • args: {
          caseAuthenticatedTags?: CaseAuthenticatedTag[];
          fabric: undefined | Fabric;
          id: number;
          isInitiator: boolean;
          isResumption: boolean;
          manager?: SessionManager;
          peerNodeId: NodeId;
          peerSessionId: number;
          peerSessionParameters?: Partial<SessionParameters>;
          salt: Uint8Array;
          sharedSecret: Uint8Array;
      }

    Returns Promise<SecureSession>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods