Class default

This module connects Leute with the lower level connection stuff.

This module basically looks for OneInstanceEndpoints in leute and creates connection routes for each of them. See the lowe level ConnectionRouteManager for mor details on what routes are.

Index

Constructors

constructor

new default(leuteModel, config): default
Create instance. Outgoing connections are made based on the contact objects.
Parameters
- leuteModel: default
  The model managing all contacts. Used for deciding which connections to establish.
- config: Partial<LeuteConnectionsModuleConfiguration>
Returns default
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:247

Properties

onConnectionsChange

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

Event is emitted when a connection is established or closed.

onKnownConnection

onKnownConnection: OEvent<((conn: default, localPersonId: SHA256IdHash<Person>, localInstanceId: SHA256IdHash<Instance>, remotePersonId: SHA256IdHash<Person>, remoteInstanceId: SHA256IdHash<Instance>, initiatedLocally: boolean, routeGropuId: string) => void)> = ...

Event that is emitted if an incoming connection was accepted and the identity of the other side is known

onOnlineStateChange

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

Event is emitted when the state of the connector changes. The event contains the value of the online state.

onUnknownConnection

onUnknownConnection: OEvent<((conn: default, localPersonId: SHA256IdHash<Person>, localInstanceId: SHA256IdHash<Instance>, remotePersonId: SHA256IdHash<Person>, remoteInstanceId: SHA256IdHash<Instance>, initiatedLocally: boolean, routeGropuId: string) => void)> = ...

Event that is emitted if an incoming connection was accepted, but the identity of the other side is not known

Accessors

newRoutesEnabled

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

Returns boolean
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:235
set newRoutesEnabled(enabled): void
Set if new routes are enabled.
Parameters
- enabled: boolean
Returns void
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:228

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 misc/ConnectionEstablishment/LeuteConnectionsModule.ts:219

Methods

connectionsInfo

connectionsInfo(filterConnectionInfos?): ConnectionInfo[]
Return information about all known connections.
Parameters
- OptionalfilterConnectionInfos: ConnectionInfoId
Returns ConnectionInfo[]
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:501

debugDump

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

disableAllConnections

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

Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:390

disableConnectionsToInstance

disableConnectionsToInstance(remoteInstanceId, localPersonId?, disable?): 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.
- disable: boolean = true
  if false, then enable instead
Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:488

disableConnectionsToPerson

disableConnectionsToPerson(remotePersonId, localPersonId?, disable?): 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.
- disable: boolean = true
  if false, then enable instead
Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:428

enableAllConnections

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

Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:383

enableConnectionsToInstance

enableConnectionsToInstance(remoteInstanceId, localPersonId?, enable?): 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.
- enable: boolean = true
  if false, then disable instead
Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:444

enableConnectionsToPerson

enableConnectionsToPerson(remotePersonId, localPersonId?, enable?): 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.
- enable: boolean = true
  if false, then disable instead
Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:402

init

init(connectionOptions?): Promise<void>
Initialize the communication.
Parameters
- OptionalconnectionOptions: {
  blacklistGroup?: default;
  initiallyDisabledGroup?: default;
  }
  - OptionalblacklistGroup?: default
  - OptionalinitiallyDisabledGroup?: default
Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:296

shutdown

shutdown(): Promise<void>
Shutdown process

Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:367

updateCache

updateCache(): Promise<void>
Returns Promise<void>
- Defined in misc/ConnectionEstablishment/LeuteConnectionsModule.ts:592

Class default

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns default

Properties

onConnectionsChange

onKnownConnection

onOnlineStateChange

onUnknownConnection

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

OptionalblacklistGroup?: default

OptionalinitiallyDisabledGroup?: default

Returns Promise<void>

shutdown

Returns Promise<void>

updateCache

Returns Promise<void>

Settings

On This Page

`Optional`blacklistGroup?: default

`Optional`initiallyDisabledGroup?: default