Class SessionManager

Manages Matter sessions associated with peer connections.

Constructors

constructor

new SessionManager(context): SessionManager
Parameters
- context: SessionManagerContext
Returns SessionManager
- Defined in packages/protocol/src/session/SessionManager.ts:123

Accessors

owner

get owner(): unknown
Returns unknown
Deprecated
- Defined in packages/protocol/src/session/SessionManager.ts:211

resubmissionStarted

get resubmissionStarted(): Observable<[session: Session], void>
Emits when resubmission is necessary due to timeout or network error.

Returns Observable<[session: Session], void>
- Defined in packages/protocol/src/session/SessionManager.ts:197

sessionParameters

get sessionParameters(): SessionParameters
Our session parameters. These are the parameters we provide during session negotiation. The peer may specify different parameters.

Returns SessionParameters
- Defined in packages/protocol/src/session/SessionManager.ts:170
set sessionParameters(parameters): void
Change session parameters.

Parameters values you omit in parameters will retain their current values. This only affects new sessions.
Parameters
- parameters: Partial<SessionParameters>
Returns void
- Defined in packages/protocol/src/session/SessionManager.ts:180

sessions

get sessions(): BasicSet<SecureSession, SecureSession>
Active secure sessions.

Returns BasicSet<SecureSession, SecureSession>
- Defined in packages/protocol/src/session/SessionManager.ts:155

subscriptionsChanged

get subscriptionsChanged(): Observable<[session: SecureSession, subscription: Subscription], void>
Emits when there is a change to the subscription set.

Returns Observable<[session: SecureSession, subscription: Subscription], void>
- Defined in packages/protocol/src/session/SessionManager.ts:190

Methods

clear

clear(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/src/session/SessionManager.ts:545

clearSubscriptionsForNode

clearSubscriptionsForNode(fabricIndex, nodeId, flushSubscriptions?): Promise<void>
Parameters
- fabricIndex: FabricIndex
- nodeId: NodeId
- OptionalflushSubscriptions: boolean
Returns Promise<void>
- Defined in packages/protocol/src/session/SessionManager.ts:561

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/protocol/src/session/SessionManager.ts:527

createInsecureSession

createInsecureSession(options): InsecureSession
Parameters
- options: {
      initiatorNodeId?: NodeId;
      isInitiator?: boolean;
      sessionParameters?: Partial<SessionParameters>;
  }
  - OptionalinitiatorNodeId?: NodeId
  - OptionalisInitiator?: boolean
  - OptionalsessionParameters?: Partial<SessionParameters>
Returns InsecureSession
- Defined in packages/protocol/src/session/SessionManager.ts:215

createSecureSession

createSecureSession(args): Promise<SecureSession>
Parameters
- args: {
      caseAuthenticatedTags?: CaseAuthenticatedTag[];
      fabric: undefined | Fabric;
      isInitiator: boolean;
      isResumption: boolean;
      peerNodeId: NodeId;
      peerSessionId: number;
      peerSessionParameters?: Partial<SessionParameters>;
      salt: Uint8Array;
      sessionId: number;
      sharedSecret: Uint8Array;
  }
  - OptionalcaseAuthenticatedTags?: CaseAuthenticatedTag[]
  - fabric: undefined | Fabric
  - isInitiator: boolean
  - isResumption: boolean
  - peerNodeId: NodeId
  - peerSessionId: number
  - OptionalpeerSessionParameters?: Partial<SessionParameters>
  - salt: Uint8Array
  - sessionId: number
  - sharedSecret: Uint8Array
Returns Promise<SecureSession>
- Defined in packages/protocol/src/session/SessionManager.ts:245

deleteResumptionRecord

deleteResumptionRecord(address): Promise<void>
Parameters
- address: PeerAddress
Returns Promise<void>
- Defined in packages/protocol/src/session/SessionManager.ts:301

deleteResumptionRecordsForFabric

deleteResumptionRecordsForFabric(fabric): Promise<void>
Parameters
- fabric: Fabric
Returns Promise<void>
- Defined in packages/protocol/src/session/SessionManager.ts:308

fabricFor

fabricFor(address): Fabric
Convenience function for accessing a fabric by address.
Parameters
- address: FabricIndex | PeerAddress
Returns Fabric
- Defined in packages/protocol/src/session/SessionManager.ts:204

findGroupSession

findGroupSession(groupId, groupSessionId): void
Parameters
- groupId: number
- groupSessionId: number
Returns void
- Defined in packages/protocol/src/session/SessionManager.ts:401

findOldestInactiveSession

findOldestInactiveSession(): SecureSession
Returns SecureSession
- Defined in packages/protocol/src/session/SessionManager.ts:320

findResumptionRecordByAddress

findResumptionRecordByAddress(address): undefined | ResumptionRecord
Parameters
- address: PeerAddress
Returns undefined | ResumptionRecord
- Defined in packages/protocol/src/session/SessionManager.ts:417

findResumptionRecordById

findResumptionRecordById(resumptionId): undefined | ResumptionRecord
Parameters
- resumptionId: Uint8Array
Returns undefined | ResumptionRecord
- Defined in packages/protocol/src/session/SessionManager.ts:412

getActiveSessionInformation

getActiveSessionInformation(): {
    fabric: undefined | ExposedFabricInformation;
    isPeerActive: boolean;
    lastActiveTimestamp: undefined | number;
    lastInteractionTimestamp: undefined | number;
    name: string;
    nodeId: NodeId;
    numberOfActiveSubscriptions: number;
    peerNodeId: NodeId;
    secure: boolean;
}[]
Returns {
    fabric: undefined | ExposedFabricInformation;
    isPeerActive: boolean;
    lastActiveTimestamp: undefined | number;
    lastInteractionTimestamp: undefined | number;
    name: string;
    nodeId: NodeId;
    numberOfActiveSubscriptions: number;
    peerNodeId: NodeId;
    secure: boolean;
}[]
- Defined in packages/protocol/src/session/SessionManager.ts:510

getNextAvailableSessionId

getNextAvailableSessionId(): Promise<number>
Returns Promise<number>
- Defined in packages/protocol/src/session/SessionManager.ts:335

getPaseSession

getPaseSession(): SecureSession
Returns SecureSession
- Defined in packages/protocol/src/session/SessionManager.ts:361

getSession

getSession(sessionId): undefined | SecureSession
Parameters
- sessionId: number
Returns undefined | SecureSession
- Defined in packages/protocol/src/session/SessionManager.ts:355

getSessionForNode

getSessionForNode(address): undefined | SecureSession
Parameters
- address: PeerAddress
Returns undefined | SecureSession
- Defined in packages/protocol/src/session/SessionManager.ts:369

getUnsecureSession

getUnsecureSession(sourceNodeId?): undefined | InsecureSession
Parameters
- OptionalsourceNodeId: NodeId
Returns undefined | InsecureSession
- Defined in packages/protocol/src/session/SessionManager.ts:392

removeAllSessionsForNode

removeAllSessionsForNode(address, sendClose?): Promise<void>
Parameters
- address: PeerAddress
- sendClose: boolean = false
Returns Promise<void>
- Defined in packages/protocol/src/session/SessionManager.ts:380

saveResumptionRecord

saveResumptionRecord(resumptionRecord): Promise<void>
Parameters
- resumptionRecord: ResumptionRecord
Returns Promise<void>
- Defined in packages/protocol/src/session/SessionManager.ts:422

updateAllSubscriptions

updateAllSubscriptions(): void
Returns void
- Defined in packages/protocol/src/session/SessionManager.ts:551

`Static`[create]

[create](env): SessionManager
Parameters
- env: Environment
Returns SessionManager
- Defined in packages/protocol/src/session/SessionManager.ts:135

Class SessionManager

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns SessionManager

Accessors

construction

Returns Construction<SessionManager>

context

Returns SessionManagerContext

insecureSessions

Returns Map<NodeId, InsecureSession>

owner

Returns unknown

Deprecated

resubmissionStarted

Returns Observable<[session: Session], void>

sessionParameters

Returns SessionParameters

Parameters

Returns void

sessions

Returns BasicSet<SecureSession, SecureSession>

subscriptionsChanged

Returns Observable<[session: SecureSession, subscription: Subscription], void>

Methods

clear

Returns Promise<void>

clearSubscriptionsForNode

Parameters

Returns Promise<void>

close

Returns Promise<void>

createInsecureSession

Parameters

OptionalinitiatorNodeId?: NodeId

OptionalisInitiator?: boolean

OptionalsessionParameters?: Partial<SessionParameters>

Returns InsecureSession

createSecureSession

Parameters

OptionalcaseAuthenticatedTags?: CaseAuthenticatedTag[]

fabric: undefined | Fabric

isInitiator: boolean

isResumption: boolean

peerNodeId: NodeId

peerSessionId: number

OptionalpeerSessionParameters?: Partial<SessionParameters>

salt: Uint8Array

sessionId: number

sharedSecret: Uint8Array

Returns Promise<SecureSession>

deleteResumptionRecord

Parameters

Returns Promise<void>

deleteResumptionRecordsForFabric

Parameters

Returns Promise<void>

fabricFor

Parameters

Returns Fabric

findGroupSession

Parameters

Returns void

findOldestInactiveSession

Returns SecureSession

findResumptionRecordByAddress

Parameters

Returns undefined | ResumptionRecord

findResumptionRecordById

Parameters

Returns undefined | ResumptionRecord

getActiveSessionInformation

Returns { fabric: undefined | ExposedFabricInformation; isPeerActive: boolean; lastActiveTimestamp: undefined | number; lastInteractionTimestamp: undefined | number; name: string; nodeId: NodeId; numberOfActiveSubscriptions: number; peerNodeId: NodeId; secure: boolean; }[]

getNextAvailableSessionId

Returns Promise<number>

`Optional`initiatorNodeId?: NodeId

`Optional`isInitiator?: boolean

`Optional`sessionParameters?: Partial<SessionParameters>

`Optional`caseAuthenticatedTags?: CaseAuthenticatedTag[]

`Optional`peerSessionParameters?: Partial<SessionParameters>

Returns {
fabric: undefined | ExposedFabricInformation;
isPeerActive: boolean;
lastActiveTimestamp: undefined | number;
lastInteractionTimestamp: undefined | number;
name: string;
nodeId: NodeId;
numberOfActiveSubscriptions: number;
peerNodeId: NodeId;
secure: boolean;
}[]

`Static`[create]