Class InsecureSession

Hierarchy (view full)

Session
- InsecureSession

Constructors

constructor

new InsecureSession(args): InsecureSession
Parameters
- args: {
      initiatorNodeId?: NodeId;
      isInitiator?: boolean;
      manager?: SessionManager;
      messageCounter: MessageCounter;
      sessionParameters?: Partial<SessionParameters>;
  }
  - OptionalinitiatorNodeId?: NodeId
  - OptionalisInitiator?: boolean
  - Optionalmanager?: SessionManager
  - messageCounter: MessageCounter
  - OptionalsessionParameters?: Partial<SessionParameters>
Returns InsecureSession
Overrides Session.constructor
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:16

Properties

`Protected` `Readonly`activeIntervalMs

activeIntervalMs: number

`Protected` `Readonly`activeThresholdMs

activeThresholdMs: number

activeTimestamp

activeTimestamp: number

`Optional`closer

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.

`Readonly`closingAfterExchangeFinished

closingAfterExchangeFinished = false

`Protected` `Readonly`dataModelRevision

dataModelRevision: number

`Protected` `Readonly`idleIntervalMs

idleIntervalMs: number

`Protected` `Readonly`interactionModelRevision

interactionModelRevision: number

`Protected` `Readonly`maxPathsPerInvoke

maxPathsPerInvoke: number

`Protected` `Readonly`messageCounter

messageCounter: MessageCounter

`Protected` `Readonly`messageReceptionState

messageReceptionState: MessageReceptionState

`Protected` `Readonly`specificationVersion

specificationVersion: number

`Readonly`supportsMRP

supportsMRP = true

timestamp

timestamp: number

Accessors

associatedFabric

get associatedFabric(): Fabric
Returns Fabric
Overrides Session.associatedFabric
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:34

attestationChallengeKey

get attestationChallengeKey(): Uint8Array
Returns Uint8Array
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:27

id

get id(): number
Returns number
Overrides Session.id
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:30

isPase

get isPase(): boolean
Returns boolean
Overrides Session.isPase
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:24

isSecure

get isSecure(): boolean
Returns boolean
Overrides Session.isSecure
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:23

`Protected`manager

get manager(): undefined | SessionManager
Returns undefined | SessionManager
Inherited from Session.manager
- Defined in packages/protocol/dist/esm/session/Session.d.ts:96

name

get name(): string
Returns string
Overrides Session.name
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:29

nodeId

get nodeId(): NodeId
Returns NodeId
Overrides Session.nodeId
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:32

owner

get owner(): unknown
Returns unknown
Deprecated
Inherited from Session.owner
- Defined in packages/protocol/dist/esm/session/Session.d.ts:100

parameters

get parameters(): SessionParameters
The peer's session parameters.

Returns SessionParameters
Inherited from Session.parameters
- Defined in packages/protocol/dist/esm/session/Session.d.ts:83

peerNodeId

get peerNodeId(): undefined
Returns undefined
Overrides Session.peerNodeId
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:33

peerSessionId

get peerSessionId(): number
Returns number
Overrides Session.peerSessionId
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:31

Methods

decode

decode(packet): DecodedMessage
Parameters
- packet: DecodedPacket
Returns DecodedMessage
Overrides Session.decode
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:25

destroy

destroy(): Promise<void>
Returns Promise<void>
Overrides Session.destroy
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:35

encode

encode(message): Packet
Parameters
- message: Message
Returns Packet
Overrides Session.encode
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:26

end

end(): Promise<void>
Returns Promise<void>
Overrides Session.end
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:36

getIncrementedMessageCounter

getIncrementedMessageCounter(): Promise<number>
Returns Promise<number>
Inherited from Session.getIncrementedMessageCounter
- Defined in packages/protocol/dist/esm/session/Session.d.ts:78

isPeerActive

isPeerActive(): boolean
Returns boolean
Inherited from Session.isPeerActive
- Defined in packages/protocol/dist/esm/session/Session.d.ts:77

notifyActivity

notifyActivity(messageReceived): void
Parameters
- messageReceived: boolean
Returns void
Inherited from Session.notifyActivity
- Defined in packages/protocol/dist/esm/session/Session.d.ts:76

setFabric

setFabric(_fabric): void
Parameters
- _fabric: Fabric
Returns void
- Defined in packages/protocol/dist/esm/session/InsecureSession.d.ts:28

updateMessageCounter

updateMessageCounter(messageCounter, _sourceNodeId?): void
Parameters
- messageCounter: number
- Optional_sourceNodeId: NodeId
Returns void
Inherited from Session.updateMessageCounter
- Defined in packages/protocol/dist/esm/session/Session.d.ts:79

Class InsecureSession

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

OptionalinitiatorNodeId?: NodeId

OptionalisInitiator?: boolean

Optionalmanager?: SessionManager

messageCounter: MessageCounter

OptionalsessionParameters?: Partial<SessionParameters>

Returns InsecureSession

Properties

Protected ReadonlyactiveIntervalMs

Protected ReadonlyactiveThresholdMs

activeTimestamp

Optionalcloser

ReadonlyclosingAfterExchangeFinished

Protected ReadonlydataModelRevision

Protected ReadonlyidleIntervalMs

Protected ReadonlyinteractionModelRevision

Protected ReadonlymaxPathsPerInvoke

Protected ReadonlymessageCounter

Protected ReadonlymessageReceptionState

Protected ReadonlyspecificationVersion

ReadonlysupportsMRP

timestamp

Accessors

associatedFabric

Returns Fabric

attestationChallengeKey

Returns Uint8Array

id

Returns number

isPase

Returns boolean

isSecure

Returns boolean

Protectedmanager

Returns undefined | SessionManager

name

Returns string

nodeId

Returns NodeId

owner

Returns unknown

Deprecated

parameters

Returns SessionParameters

peerNodeId

Returns undefined

peerSessionId

Returns number

Methods

decode

Parameters

Returns DecodedMessage

destroy

Returns Promise<void>

encode

Parameters

Returns Packet

end

Returns Promise<void>

getIncrementedMessageCounter

Returns Promise<number>

isPeerActive

Returns boolean

notifyActivity

Parameters

Returns void

setFabric

Parameters

Returns void

updateMessageCounter

Parameters

`Optional`initiatorNodeId?: NodeId

`Optional`isInitiator?: boolean

`Optional`manager?: SessionManager

`Optional`sessionParameters?: Partial<SessionParameters>

`Protected` `Readonly`activeIntervalMs

`Protected` `Readonly`activeThresholdMs

`Optional`closer

`Readonly`closingAfterExchangeFinished

`Protected` `Readonly`dataModelRevision

`Protected` `Readonly`idleIntervalMs

`Protected` `Readonly`interactionModelRevision

`Protected` `Readonly`maxPathsPerInvoke

`Protected` `Readonly`messageCounter

`Protected` `Readonly`messageReceptionState

`Protected` `Readonly`specificationVersion

`Readonly`supportsMRP

`Protected`manager