Class default

constructor

• new default(connection: default): default

  Creates a server connection based on a WebSocket object

  Parameters

  • connection: default

  Returns default

connection

id

• get id(): number

  Returns number

webSocket

• get webSocket(): WebSocket

  Get the underlying web socket instance

  Returns WebSocket

close

• close(reason?: string): void

  Closes the web socket.

  Parameters

  • Optionalreason: string

    The reason for closing. If specified it is sent unencrypted to the remote side!

  Returns void

releaseWebSocket

• releaseWebSocket(): WebSocket

  Releases the underlying websocket, so that it can be used by another class.

  Attention: If messages arrive in the meantime they might get lost.

  Returns WebSocket

sendAuthenticationRequestMessage

• sendAuthenticationRequestMessage(
      publicKey: PublicKey,
      challenge: Uint8Array,
  ): Promise<void>

  Send authentication request message.

  Parameters

  • publicKey: PublicKey

    the publicKey of the communication server
  • challenge: Uint8Array

    the challenge that has to be decrypted by the receiver and sent back in an authentication response message

  Returns Promise<void>

sendAuthenticationSuccessMessage

• sendAuthenticationSuccessMessage(pingInterval: number): Promise<void>

  Send the authentication success message.

  Parameters

  • pingInterval: number

  Returns Promise<void>

sendCommunicationRequestMessage

• sendCommunicationRequestMessage(
      sourcePublicKey: PublicKey,
      targetPublicKey: PublicKey,
  ): Promise<void>

  Send the communication request message

  Parameters

  • sourcePublicKey: PublicKey
  • targetPublicKey: PublicKey

  Returns Promise<void>

sendConnectionHandoverMessage

• sendConnectionHandoverMessage(): Promise<void>

  Send the connection handover message.

  Returns Promise<void>

sendPingMessage

• sendPingMessage(): Promise<void>

  Send Ping Message

  Returns Promise<void>

startPingPong

• startPingPong(pingInterval: number, pongTimeout: number): void

  Starts pinging the client.

  Parameters

  • pingInterval: number

    Interval since last pong when to send another ping.
  • pongTimeout: number

    Time to wait for the pong (after a ping) before severing the connection.

  Returns void

stopPingPong

• stopPingPong(): Promise<void>

  Stops the ping / pong process.

  If currently waiting for a pong, then the promise resolves

  1. After the pong was received
  2. After the pong timeout was reached

  Returns Promise<void>

waitForAnyMessage

• waitForAnyMessage(): Promise<ClientMessageTypes>

  Wait for an arbitrary client message.

  Returns Promise<ClientMessageTypes>

waitForMessage

• waitForMessage<T extends keyof ClientMessages>(
      command: T,
  ): Promise<ClientMessages[T]>

  Wait for a client message with certain type.

  Type Parameters

  • T extends keyof ClientMessages

  Parameters

  • command: T

    expected command of message.

  Returns Promise<ClientMessages[T]>