Class default

constructor

• new default(
      leuteModel: default,
      config: Partial<LeuteConnectionsModuleConfiguration>,
  ): 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

onConnectionError

onConnectionsChange

onKnownConnection

onOnlineStateChange

onUnknownConnection

newRoutesEnabled

• get newRoutesEnabled(): boolean

  Returns if new routes will be enabled.

  Returns boolean
• set newRoutesEnabled(enabled: boolean): void

  Set if new routes are enabled.

  Parameters

  • enabled: boolean

  Returns void

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

connectionsInfo

• connectionsInfo(filterConnectionInfos?: ConnectionInfoId): ConnectionInfo[]

  Return information about all known connections.

  Parameters

  • OptionalfilterConnectionInfos: ConnectionInfoId

  Returns ConnectionInfo[]

debugDump

• debugDump(header?: string): void

  Dumps all information about connections and routes in readable form to console.

  Parameters

  • header: string = ''

  Returns void

disableAllConnections

• disableAllConnections(): Promise<void>

  Disable all connections.

  Returns Promise<void>

disableConnectionsToInstance

• disableConnectionsToInstance(
      remoteInstanceId: SHA256IdHash<Instance>,
      localPersonId?: SHA256IdHash<Person>,
      disable?: boolean,
  ): 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>

disableConnectionsToPerson

• disableConnectionsToPerson(
      remotePersonId: SHA256IdHash<Person>,
      localPersonId?: SHA256IdHash<Person>,
      disable?: boolean,
  ): 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>

enableAllConnections

• enableAllConnections(): Promise<void>

  Enable all connections.

  Returns Promise<void>

enableConnectionsToInstance

• enableConnectionsToInstance(
      remoteInstanceId: SHA256IdHash<Instance>,
      localPersonId?: SHA256IdHash<Person>,
      enable?: boolean,
  ): 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>

enableConnectionsToPerson

• enableConnectionsToPerson(
      remotePersonId: SHA256IdHash<Person>,
      localPersonId?: SHA256IdHash<Person>,
      enable?: boolean,
  ): 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>

init

• init(
      connectionOptions?: {
          blacklistGroup?: default;
          initiallyDisabledGroup?: default;
      },
  ): Promise<void>

  Initialize the communication.

  Parameters

  • OptionalconnectionOptions: { blacklistGroup?: default; initiallyDisabledGroup?: default }

  Returns Promise<void>

shutdown

• shutdown(): Promise<void>

  Shutdown process

  Returns Promise<void>

updateCache

• updateCache(): Promise<void>

  Returns Promise<void>