Class default

constructor

• new default(): default

• Returns default

onConnection

onOnlineStateChange

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

listenForCommunicationServerConnections

• listenForCommunicationServerConnections(commServerUrl, cryptoApi, listenerIdPrefix?): Promise<(() => Promise<void>)>

• Listen for connections using a communication server.

  Parameters

  • commServerUrl: string

    The communication server to use. (URL is passed to WebSocket)
  • cryptoApi: CryptoApi
  • OptionallistenerIdPrefix: string

    The prefix to add before the listener id

  Returns Promise<(() => Promise<void>)>

listenForDirectConnections

• listenForDirectConnections(host, port, cryptoApi, listenerIdPrefix?): Promise<(() => Promise<void>)>

• Listen for direct connections.

  This function will start a listening websocket server only the first time this function is called with the same host / port / localPublicKey options. All following calls will just increase a reference counter, but not start a listening

  Parameters

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

    The prefix to add before the listener id

  Returns Promise<(() => Promise<void>)>

shutdown

• shutdown(): Promise<void>

• Shutdown the listeners.

  This does not shutdown the already established encrypted connections, it just shuts down the listeners.

  Returns Promise<void>

startNewCommunicationServerListener

• startNewCommunicationServerListener(commServerUrl, cryptoApi, listenerId): Promise<CommServerListenerInfo>

• Parameters

  • commServerUrl: string
  • cryptoApi: CryptoApi
  • listenerId: string

  Returns Promise<CommServerListenerInfo>

stopListeningForCommunicationServerConnections

• stopListeningForCommunicationServerConnections(commServerUrl, cryptoApi): Promise<void>

• Parameters

  • commServerUrl: string
  • cryptoApi: CryptoApi

  Returns Promise<void>

stopListeningForDirectConnections

• stopListeningForDirectConnections(host, port, localPublicKey): Promise<void>

• Parameters

  • host: string
  • port: number
  • localPublicKey: PublicKey

  Returns Promise<void>

StaticcommunicationServerListenerId

• communicationServerListenerId(commServerUrl, localPublicKey, listenerIdPrefix?): string

• Parameters

  • commServerUrl: string
  • localPublicKey: LocalPublicKey
  • OptionallistenerIdPrefix: string

  Returns string

StaticdirectConnectionListenerId

• directConnectionListenerId(host, port, listenerIdPrefix?): string

• Parameters

  • host: string
  • port: number
  • OptionallistenerIdPrefix: string

  Returns string