Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseClientPool

The client pool maintains a list of all clients

Hierarchy

  • BaseClientPool

Index

Constructors

constructor

  • Parameters

    • __namedParameters: object
      • logger: any
      • maxClients: number
      • server: any

    Returns BaseClientPool

Methods

allocateClient

  • allocateClient(ws: any): boolean
  • Creates a new client for an incoming connection

    Parameters

    • ws: any

    Returns boolean

getStats

  • getStats(): any
  • Returns the current cached stats

    Returns any

handleConnectionClose

  • handleConnectionClose(ws: any, allowReconnect?: boolean): boolean
  • Handles a connection close of a client

    Parameters

    • ws: any
    • Default value allowReconnect: boolean = true

    Returns boolean

handleGracefulDisconnect

  • handleGracefulDisconnect(ws: any, client: any): void
  • Handles a requested disconnect

    Parameters

    • ws: any
    • client: any

    Returns void

handlePacket

  • handlePacket(ws: any, packet: any): boolean
  • Handles a packet from a client

    Parameters

    • ws: any
    • packet: any

    Returns boolean

handleReconnect

  • handleReconnect(ws: any, client: any, token: any): boolean
  • Attempts to handle a reconnect

    Parameters

    • ws: any
    • client: any
    • token: any

    Returns boolean

internalComputeStats

  • internalComputeStats(): void
  • Refreshes the client stats

    Returns void

internalMakeClientHandle

  • internalMakeClientHandle(ws: any): void
  • Parameters

    • ws: any

    Returns void

kick

  • kick(client: any, closeSocket?: boolean): boolean
  • Kicks a client from the server

    Parameters

    • client: any
    • Default value closeSocket: boolean = true

      Whether to also close the socket. If you want to send some packet before, this must be false

    Returns boolean

    true on success

removeOldReconnects

  • removeOldReconnects(now: any): void
  • Removes old reconnect possibilities

    Parameters

    • now: any

      total time seconds

    Returns void

tick

  • tick(now: any, dt: any): void
  • Parameters

    • now: any

      total time seconds

    • dt: any

      delta seconds

    Returns void