Class PersistentConnection<ConnectAddress, Connection>

constructor

• new PersistentConnection<ConnectAddress, Connection extends IClosable>(
      params: {
          connect: (
              address: ConnectAddress,
              abortSignal: AbortSignal,
          ) => Promise<Connection>;
          onClose?: () => MaybePromise<void>;
          onError?: (
              error: Error,
              connection: null | Connection,
              state: ReconnectionState,
          ) => MaybePromise<OnErrorAction>;
          onOpen: (connection: Connection) => Promise<void>;
          onWait?: (wait: number) => void;
          strategy?: ReconnectionStrategy;
      },
  ): PersistentConnection<ConnectAddress, Connection>

• Type Parameters

  • ConnectAddress
  • Connection extends IClosable

  Parameters

  • params: {
        connect: (
            address: ConnectAddress,
            abortSignal: AbortSignal,
        ) => Promise<Connection>;
        onClose?: () => MaybePromise<void>;
        onError?: (
            error: Error,
            connection: null | Connection,
            state: ReconnectionState,
        ) => MaybePromise<OnErrorAction>;
        onOpen: (connection: Connection) => Promise<void>;
        onWait?: (wait: number) => void;
        strategy?: ReconnectionStrategy;
    }

    • connect: (address: ConnectAddress, abortSignal: AbortSignal) => Promise<Connection>

      Open a connection. The signal is aborted if the connection is closed before this resolves.

    • OptionalonClose?: () => MaybePromise<void>

    • OptionalonError?: (
          error: Error,
          connection: null | Connection,
          state: ReconnectionState,
      ) => MaybePromise<OnErrorAction>

      Function that will be called whenever an error happens while connecting (in which case connection will be null) or inside onOpen.

      Default

      (err) => err instanceof ConnectionClosedError ? 'reconnect' : 'close'

    • onOpen: (connection: Connection) => Promise<void>

      Function to call once the connection is open

      As soon as the promise is resolved the connection will be closed (and will not be re-opened automatically), so this is the best place to put your recv loop

    • OptionalonWait?: (wait: number) => void

    • Optionalstrategy?: ReconnectionStrategy

  Returns PersistentConnection<ConnectAddress, Connection>

Readonlyparams

connection

• get connection(): null | Connection

• Returns null | Connection

isConnected

• get isConnected(): boolean

• Returns boolean

isConnecting

• get isConnecting(): boolean

• Returns boolean

isWaiting

• get isWaiting(): boolean

• Returns boolean

state

• get state(): ReconnectionState

• Returns ReconnectionState

changeTransport

• changeTransport(
      connect: (
          address: ConnectAddress,
          abortSignal: AbortSignal,
      ) => Promise<Connection>,
  ): Promise<void>

• Parameters

  • connect: (address: ConnectAddress, abortSignal: AbortSignal) => Promise<Connection>

  Returns Promise<void>

close

• close(): Promise<void>

• Returns Promise<void>

connect

• connect(address: ConnectAddress): void

• Parameters

  • address: ConnectAddress

  Returns void

reconnect

• reconnect(force: boolean): void

• Parameters

  • force: boolean

    Whether to close the existing connection if there is one

  Returns void