Class SocketClient

src/shared/back/SocketClient.ts:23–288

type AnyCallback<T, U extends number> = (event: T, type: U, args: any[]) => void

export class SocketClient<SOCKET extends BaseSocket> {
  api: SocketAPIData<BackOut, BackOutTemplate, EVENT> = create_api();

  /** If true, do not attempt to reconnect */
  abortReconnects = false;

  /** Kill self if connection ever fully dies (can't reconnect) */
  killOnDisconnect = false;

  client: SocketServerClient<BackIn, BackInTemplate, SOCKET> = {
    id: -1, // Unused (only used by servers)
    next_id: 0,
    sent: [],
    socket: undefined,
  };

  url = '';
  secret = '';
  /** Constructor of the socket used by this. */
  socketCon: SocketConstructor<SOCKET>;
  /** If the socket should be kept open. */
  keepOpen = false;

  /** Callbacks for when the socket starts listening. */
  protected when_listeners: (() => void)[] = [];

  constructor(
    socketCon: SocketConstructor<SOCKET>,
    private onFatal?: () => void,
    public onStateChange?: (open: boolean) => void,
  ) {
    this.socketCon = socketCon;
  }

  /** Resolves when the socket starts listening. If it is already listening this is resolved immediately. */
  whenListening(): Promise<void> {
    return new Promise((resolve) => {
      if (this.client.socket && this.client.socket.readyState === WebSocket.OPEN) {
        resolve();
      } else {
        this.when_listeners.push(resolve);
      }
    });
  }

  setSocket(socket: SOCKET): void {
    this.keepOpen = true;
    this.client.socket = socket;
    this.client.socket.onmessage = this.onMessage.bind(this);
    this.client.socket.onerror = this.onError.bind(this);
    this.client.socket.onclose = this.onClose.bind(this);
    this.client.socket.onopen = this.onOpen.bind(this);
    this.ensureConnection();
  }

  listen(socket: SOCKET): void {
    this.unlisten();