Class default

constructor

• new default(reconnectDelayOnClose?: number): default

  Parameters

  • reconnectDelayOnClose: number = 5000

    Real reconnect delay is randomized in the intrval [reconnectDelay, reconnectInterval * 2]

  Returns default

onConnection

onConnectionsChange

onConnectionViaCatchAll

onOnlineStateChange

onlineState

• get onlineState(): boolean

  Returns boolean

addIncomingWebsocketRoute_CommServer

• addIncomingWebsocketRoute_CommServer(
      cryptoApi: CryptoApi,
      remotePublicKey: PublicKey,
      commServerUrl: string,
      connectionRoutesGroupName: string,
  ): { id: string; isNew: boolean }

  Parameters

  • cryptoApi: CryptoApi
  • remotePublicKey: PublicKey
  • commServerUrl: string
  • connectionRoutesGroupName: string

  Returns { id: string; isNew: boolean }

addIncomingWebsocketRoute_Direct

• addIncomingWebsocketRoute_Direct(
      cryptoApi: CryptoApi,
      remotePublicKey: PublicKey,
      host: string,
      port: number,
      connectionRoutesGroupName: string,
  ): { id: string; isNew: boolean }

  Parameters

  • cryptoApi: CryptoApi
  • remotePublicKey: PublicKey
  • host: string
  • port: number
  • connectionRoutesGroupName: string

  Returns { id: string; isNew: boolean }

addIncomingWebsocketRouteCatchAll_CommServer

• addIncomingWebsocketRouteCatchAll_CommServer(
      cryptoApi: CryptoApi,
      commServerUrl: string,
  ): { id: string; isNew: boolean }

  Parameters

  • cryptoApi: CryptoApi
  • commServerUrl: string

  Returns { id: string; isNew: boolean }

addIncomingWebsocketRouteCatchAll_Direct

• addIncomingWebsocketRouteCatchAll_Direct(
      cryptoApi: CryptoApi,
      host: string,
      port: number,
  ): { id: string; isNew: boolean }

  Parameters

  • cryptoApi: CryptoApi
  • host: string
  • port: number

  Returns { id: string; isNew: boolean }

addOutgoingWebsocketRoute

• addOutgoingWebsocketRoute(
      cryptoApi: SymmetricCryptoApiWithKeys,
      url: string,
      connectionRoutesGroupName: string,
  ): { id: string; isNew: boolean }

  Parameters

  • cryptoApi: SymmetricCryptoApiWithKeys
  • url: string
  • connectionRoutesGroupName: string

  Returns { id: string; isNew: boolean }

closeConnections

• closeConnections(
      localPublicKey?: PublicKey,
      remotePublicKey?: PublicKey,
      connectionRoutesGroupName?: string,
      catchAll?: boolean,
  ): void

  Parameters

  • OptionallocalPublicKey: PublicKey
  • OptionalremotePublicKey: PublicKey
  • OptionalconnectionRoutesGroupName: string
  • OptionalcatchAll: boolean

  Returns void

connectionRoutesInformation

• connectionRoutesInformation(): {
      catchAllRoutes: CatchAllRoutes[];
      connectionsRoutesGroups: ConnectionRoutesGroup[];
  }

  This returns all connection routes gorups.

  The returned value is only meant to be used to display information, do not alter anything in there, because it is not a copy of the internal data structures!

  Returns {
      catchAllRoutes: CatchAllRoutes[];
      connectionsRoutesGroups: ConnectionRoutesGroup[];
  }

debugDump

• debugDump(header?: string): void

  Dump the connection information to console.

  Parameters

  • header: string = ''

  Returns void

disableCatchAllRoutes

• disableCatchAllRoutes(
      localPublicKey?: PublicKey,
      routeId?: string,
  ): Promise<void>

  Disables all catch-all routes matching the passed parameters.

  Parameters

  • OptionallocalPublicKey: PublicKey
  • OptionalrouteId: string

  Returns Promise<void>

disableRoutes

• disableRoutes(
      localPublicKey?: PublicKey,
      remotePublicKey?: PublicKey,
      connectionRoutesGroupName?: string,
      routeId?: string,
  ): Promise<void>

  Disables all routes matching the passed parameters.

  This also includes catch-all routes if only the localPublicKey and / or routeId is set.

  Parameters

  • OptionallocalPublicKey: PublicKey
  • OptionalremotePublicKey: PublicKey
  • OptionalconnectionRoutesGroupName: string
  • OptionalrouteId: string

  Returns Promise<void>

enableCatchAllRoutes

• enableCatchAllRoutes(
      localPublicKey?: PublicKey,
      routeId?: string,
  ): Promise<void>

  Enables all catch-all routes matching the passed parameters.

  Parameters

  • OptionallocalPublicKey: PublicKey
  • OptionalrouteId: string

  Returns Promise<void>

enableRoutes

• enableRoutes(
      localPublicKey?: PublicKey,
      remotePublicKey?: PublicKey,
      connectionRoutesGroupName?: string,
      routeId?: string,
  ): Promise<void>

  Enables all routes matching the passed parameters.

  This also includes catch-all routes if only the localPublicKey and / or routeId is set.

  Parameters

  • OptionallocalPublicKey: PublicKey
  • OptionalremotePublicKey: PublicKey
  • OptionalconnectionRoutesGroupName: string
  • OptionalrouteId: string

  Returns Promise<void>

isOutgoingWebsocketRouteExisting

• isOutgoingWebsocketRouteExisting(
      url: string,
      localPublicKey: PublicKey,
      remotePublicKey: PublicKey,
      connectionRoutesGroupName: string,
  ): boolean

  Parameters

  • url: string
  • localPublicKey: PublicKey
  • remotePublicKey: PublicKey
  • connectionRoutesGroupName: string

  Returns boolean

StaticappendToConnectionStatisticsLog

• appendToConnectionStatisticsLog(
      connectionRoutesGroup: ConnectionRoutesGroup,
  ): void

  Append a new entry to the connectionsStatisticsLog.

  Limits the maximum size to 10 (limit currently deactivated - heavy debugging)

  Parameters

  • connectionRoutesGroup: ConnectionRoutesGroup

  Returns void