Class default

constructor

• new default(url): default

• Creates a client connection to a communication server for registering connection listeners.

  Parameters

  • url: string

  Returns default

connection

id

• get id(): number

• Returns number

webSocket

• get webSocket(): WebSocket

• Get the underlying web socket instance

  Returns WebSocket

close

• close(reason?): void

• Closes the websocket

  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

sendAuthenticationResponseMessage

• sendAuthenticationResponseMessage(response): Promise<void>

• Send response to authentication request message.

  Parameters

  • response: Uint8Array

  Returns Promise<void>

sendRegisterMessage

• sendRegisterMessage(publicKey): Promise<void>

• Send a register message to the communication server.

  Parameters

  • publicKey: PublicKey

  Returns Promise<void>

startPingPong

• startPingPong(pingInterval, pongTimeout): void

• Starts answering pings of the server.

  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(): void

• Stops answering pings of the server.

  Returns void

terminate

• terminate(reason?): void

• Terminates the web socket.

  Parameters

  • Optionalreason: string

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

  Returns void

waitForMessage

• waitForMessage<T>(command): Promise<ServerMessages[T]>

• Wait for a message with the specified command.

  Type Parameters

  • T extends keyof ServerMessages

  Parameters

  • command: T

    The expected command of the next message

  Returns Promise<ServerMessages[T]>