Class GobanSocket<SendProtocol, RecvProtocol>

This is a simple wrapper around the WebSocket API that provides a simple interface to connect to the Online-Go.com servers. It provides:

  • Reconnection
  • Deals with authentication
  • Event based API
  • Type safe sends and receives
  • Optional promise support for sends
  • Latency tracking (doubling as keep alive)

Type Parameters

Hierarchy

Constructors

constructor

Properties

authentication? callbacks clock_drift last_request_id latency manually_disconnected options ping_interval? promises_in_flight reconnect_tries reconnecting send_queue socket url

Accessors

connected

Methods

authenticate connect disconnect reconnect rejectPromisesInFlight send sendAuthentication sendPromise startPing

Constructors

constructor

Properties

Private Optional authentication

authentication?: DataArgument<SendProtocol["authenticate"]>

Private callbacks

callbacks: Map<number, ((data?: any, error?: ErrorResponse) => void)> = ...

clock_drift

clock_drift: number = 0.0

Private last_request_id

last_request_id: number = 0

latency

latency: number = 0.0

Private manually_disconnected

manually_disconnected: boolean = false

options

options: GobanSocketOptions

Private Optional ping_interval

ping_interval?: Timer

Private promises_in_flight

promises_in_flight: Map<number, {
    args: any[];
    command: string;
    reject: ((...args: any[]) => void);
    resolve: ((...args: any[]) => void);
}> = ...

Private reconnect_tries

reconnect_tries: number = 0

Private reconnecting

reconnecting: boolean = false

Private send_queue

send_queue: (() => void)[] = []

Private socket

socket: WebSocket

Readonly url

url: string

Accessors

connected

Methods

authenticate

Private connect

disconnect

Private reconnect

Private rejectPromisesInFlight

send

  • Type Parameters

    • Command extends string | number | symbol

    Parameters

    • command: Command
    • data: DataArgument<SendProtocol[Command]>
    • Optional cb: ((data: ResponseType<SendProtocol[Command]>, error?: any) => void)
        • (data: ResponseType<SendProtocol[Command]>, error?: any): void

        • Parameters

          • data: ResponseType<SendProtocol[Command]>
          • Optional error: any

          Returns void

    Returns void

Private sendAuthentication

sendPromise

  • Type Parameters

    • Command extends string | number | symbol

    Parameters

    Returns Promise<ResponseType<SendProtocol[Command]>>

Private startPing

Settings

Member Visibility

Theme

Generated using TypeDoc