Class default

This model manages all connections including pairing scenarios etc.

The lower levels handle the complete connection establishment based on information found in Leute. This module just executes the correct protocol when a connection was established (e.g. the chum, or the pairing protocol ...)

Pairing: Pairing is handled by the PairingManager that can be accessed by ".pairing" on this module.

Hierarchy (view full)

Model
- default

Index

Constructors

constructor

new default(leuteModel, config): default
Construct a new instance
Parameters
- leuteModel: default
- config: Partial<ConnectionsModelConfiguration>
Returns default
Overrides Model.constructor
- Defined in models/ConnectionsModel.ts:154

Properties

onConnectionsChange

onConnectionsChange: OEvent<(() => void)> = ...

Event is emitted when a connection is established or closed.

onOnlineStateChange

onOnlineStateChange: OEvent<((state: boolean) => void)> = ...

Event is emitted when state of the connector changes. The emitted value represents the updated state.

onProtocolStart

onProtocolStart: OEvent<((initiatedLocally: boolean, localPersonId: SHA256IdHash<Person>, localInstanceId: SHA256IdHash<Instance>, remotePersonId: SHA256IdHash<Person>, remoteInstanceId: SHA256IdHash<Instance>, protocol: Protocols) => void)> = ...

Event is emitted when the chum starts.

onUpdated

onUpdated: OEvent<(() => void)> = ...

`Readonly`pairing

pairing: default

state

state: StateMachine<"Uninitialised" | "Initialised", "shutdown" | "init">

Accessors

newRoutesEnabled

get newRoutesEnabled(): boolean
Returns if new routes will be enabled.

Returns boolean
- Defined in models/ConnectionsModel.ts:144
set newRoutesEnabled(enabled): void
Set if new routes are enabled.
Parameters
- enabled: boolean
Returns void
- Defined in models/ConnectionsModel.ts:137

onlineState

get onlineState(): boolean
Retrieve the online state based on connections to comm servers.

If we don't have connections to comm servers, the state will always be true.

Returns boolean
- Defined in models/ConnectionsModel.ts:128

Methods

connectionsInfo

connectionsInfo(filterConnectionInfos?): ConnectionInfo[]
Returns information about all connections and routes.
Parameters
- OptionalfilterConnectionInfos: ConnectionInfoId
Returns ConnectionInfo[]
- Defined in models/ConnectionsModel.ts:332

debugDump

debugDump(header?): void
Dumps all information about connections and routes in readable form to console.
Parameters
- header: string = ''
Returns void
- Defined in models/ConnectionsModel.ts:339

disableAllConnections

disableAllConnections(): Promise<void>
Disable all connections.

Returns Promise<void>
- Defined in models/ConnectionsModel.ts:247

disableConnectionsToInstance

disableConnectionsToInstance(remoteInstanceId, localPersonId?): Promise<void>
Disable all connections to this instance.
Parameters
- remoteInstanceId: SHA256IdHash<Instance>
- OptionallocalPersonId: SHA256IdHash<Person>
  If specified only the connections originating from this person are affected.
Returns Promise<void>
- Defined in models/ConnectionsModel.ts:319

disableConnectionsToPerson

disableConnectionsToPerson(remotePersonId, localPersonId?): Promise<void>
Disable all connections to this person.
Parameters
- remotePersonId: SHA256IdHash<Person>
- OptionallocalPersonId: SHA256IdHash<Person>
  If specified only the connections originating from this person are affected.
Returns Promise<void>
- Defined in models/ConnectionsModel.ts:281

enableAllConnections

enableAllConnections(): Promise<void>
Enable all connections.

Returns Promise<void>
- Defined in models/ConnectionsModel.ts:240

enableConnectionsToInstance

enableConnectionsToInstance(remoteInstanceId, localPersonId?): Promise<void>
Enable all connections to this instance.
Parameters
- remoteInstanceId: SHA256IdHash<Instance>
- OptionallocalPersonId: SHA256IdHash<Person>
  If specified only the connections originating from this person are affected.
Returns Promise<void>
- Defined in models/ConnectionsModel.ts:302

enableConnectionsToPerson

enableConnectionsToPerson(remotePersonId, localPersonId?): Promise<void>
Enable all connections to this person.
Parameters
- remotePersonId: SHA256IdHash<Person>
- OptionallocalPersonId: SHA256IdHash<Person>
  If specified only the connections originating from this person are affected.
Returns Promise<void>
- Defined in models/ConnectionsModel.ts:258

init

init(blacklistGroup?): Promise<void>
Initialize this module.
Parameters
- OptionalblacklistGroup: default
Returns Promise<void>
- Defined in models/ConnectionsModel.ts:217

shutdown

shutdown(): Promise<void>
Shutdown module

Returns Promise<void>
Overrides Model.shutdown
- Defined in models/ConnectionsModel.ts:230

Class default

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

onConnectionsChange

onOnlineStateChange

onProtocolStart

onUpdated

Readonlypairing

state

Accessors

newRoutesEnabled

Returns boolean

Parameters

Returns void

onlineState

Returns boolean

Methods

connectionsInfo

Parameters

Returns ConnectionInfo[]

debugDump

Parameters

Returns void

disableAllConnections

Returns Promise<void>

disableConnectionsToInstance

Parameters

Returns Promise<void>

disableConnectionsToPerson

Parameters

Returns Promise<void>

enableAllConnections

Returns Promise<void>

enableConnectionsToInstance

Parameters

Returns Promise<void>

enableConnectionsToPerson

Parameters

Returns Promise<void>

init

Parameters

Returns Promise<void>

shutdown

Returns Promise<void>

Settings

On This Page

`Readonly`pairing