Class Session`Abstract`

Hierarchy (view full)

Session
- InsecureSession
- SecureSession

Constructors

constructor

new Session(args): Session
Parameters
- args: {
      manager?: SessionManager;
      messageCounter: MessageCounter;
      messageReceptionState: MessageReceptionState;
      sessionParameters?: Partial<SessionParameters>;
      setActiveTimestamp: boolean;
  }
  - Optionalmanager?: SessionManager
  - messageCounter: MessageCounter
  - messageReceptionState: MessageReceptionState
  - OptionalsessionParameters?: Partial<SessionParameters>
  - setActiveTimestamp: boolean
Returns Session
- Defined in packages/protocol/dist/esm/session/Session.d.ts:69

Properties

`Protected` `Readonly`activeIntervalMs

activeIntervalMs: number

`Protected` `Readonly`activeThresholdMs

activeThresholdMs: number

activeTimestamp

activeTimestamp: number

`Abstract`associatedFabric

associatedFabric: Fabric

`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.

`Protected` `Readonly`dataModelRevision

dataModelRevision: number

`Abstract`id

id: number

`Protected` `Readonly`idleIntervalMs

idleIntervalMs: number

`Protected` `Readonly`interactionModelRevision

interactionModelRevision: number

`Abstract`isPase

isPase: boolean

`Abstract`isSecure

isSecure: boolean

`Protected` `Readonly`maxPathsPerInvoke

maxPathsPerInvoke: number

`Protected` `Readonly`messageCounter

messageCounter: MessageCounter

`Protected` `Readonly`messageReceptionState

messageReceptionState: MessageReceptionState

`Abstract`nodeId

nodeId: undefined | NodeId

`Abstract`peerNodeId

peerNodeId: undefined | NodeId

`Abstract`peerSessionId

peerSessionId: number

`Protected` `Readonly`specificationVersion

specificationVersion: number

`Abstract`supportsMRP

supportsMRP: boolean

timestamp

timestamp: number

Accessors

`Abstract`closingAfterExchangeFinished

get closingAfterExchangeFinished(): boolean
Returns boolean
- Defined in packages/protocol/dist/esm/session/Session.d.ts:51

`Protected`manager

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

`Abstract`name

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

owner

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

parameters

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

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

Methods

`Abstract`decode

decode(packet, aad?): DecodedMessage
Parameters
- packet: DecodedPacket
- Optionalaad: Uint8Array
Returns DecodedMessage
- Defined in packages/protocol/dist/esm/session/Session.d.ts:92

`Abstract`destroy

destroy(sendClose?, closeAfterExchangeFinished?): Promise<void>
Parameters
- OptionalsendClose: boolean
- OptionalcloseAfterExchangeFinished: boolean
Returns Promise<void>
- Defined in packages/protocol/dist/esm/session/Session.d.ts:95

`Abstract`encode

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

`Abstract`end

end(sendClose): Promise<void>
Parameters
- sendClose: boolean
Returns Promise<void>
- Defined in packages/protocol/dist/esm/session/Session.d.ts:94

getIncrementedMessageCounter

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

isPeerActive

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

notifyActivity

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

updateMessageCounter

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

Class SessionAbstract

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optionalmanager?: SessionManager

messageCounter: MessageCounter

messageReceptionState: MessageReceptionState

OptionalsessionParameters?: Partial<SessionParameters>

setActiveTimestamp: boolean

Returns Session

Properties

Protected ReadonlyactiveIntervalMs

Protected ReadonlyactiveThresholdMs

activeTimestamp

AbstractassociatedFabric

Optionalcloser

Protected ReadonlydataModelRevision

Abstractid

Protected ReadonlyidleIntervalMs

Protected ReadonlyinteractionModelRevision

AbstractisPase

AbstractisSecure

Protected ReadonlymaxPathsPerInvoke

Protected ReadonlymessageCounter

Protected ReadonlymessageReceptionState

AbstractnodeId

AbstractpeerNodeId

AbstractpeerSessionId

Protected ReadonlyspecificationVersion

AbstractsupportsMRP

timestamp

Accessors

AbstractclosingAfterExchangeFinished

Returns boolean

Protectedmanager

Returns undefined | SessionManager

Abstractname

Returns string

owner

Returns unknown

Deprecated

parameters

Returns SessionParameters

Methods

Abstractdecode

Parameters

Returns DecodedMessage

Abstractdestroy

Parameters

Returns Promise<void>

Abstractencode

Parameters

Returns Packet

Abstractend

Parameters

Returns Promise<void>

getIncrementedMessageCounter

Returns Promise<number>

isPeerActive

Returns boolean

notifyActivity

Parameters

Returns void

updateMessageCounter

Parameters

Returns void

Settings

On This Page

Class Session`Abstract`

`Optional`manager?: SessionManager

`Optional`sessionParameters?: Partial<SessionParameters>

`Protected` `Readonly`activeIntervalMs

`Protected` `Readonly`activeThresholdMs

`Abstract`associatedFabric

`Optional`closer

`Protected` `Readonly`dataModelRevision

`Abstract`id

`Protected` `Readonly`idleIntervalMs

`Protected` `Readonly`interactionModelRevision

`Abstract`isPase

`Abstract`isSecure

`Protected` `Readonly`maxPathsPerInvoke

`Protected` `Readonly`messageCounter

`Protected` `Readonly`messageReceptionState

`Abstract`nodeId

`Abstract`peerNodeId

`Abstract`peerSessionId

`Protected` `Readonly`specificationVersion

`Abstract`supportsMRP

`Abstract`closingAfterExchangeFinished

`Protected`manager

`Abstract`name

`Abstract`decode

`Abstract`destroy

`Abstract`encode

`Abstract`end