Class SocketSession

constructor

• new SocketSession(
      app: Application,
      server: SocketBridgeServer,
      world: World,
      id: string,
      clientId: string,
  ): SocketSession

  Parameters

  • app: Application
  • server: SocketBridgeServer
  • world: World
  • id: string
  • clientId: string

  Returns SocketSession

Readonly_awaitingResponses

ReadonlyclientId

Readonlyid

Readonlyworld

averagePing

• get averagePing(): number

  Returns number

destroy

• destroy(): void

  Returns void

disconnect

• disconnect(reason?: DisconnectReason): Promise<void>

  Parameters

  • reason: DisconnectReason = DisconnectReason.Disconnect

  Returns Promise<void>

reconnect

• reconnect(): Promise<void>

  Returns Promise<void>

send

• send<
      A extends
          BaseAction<string, unknown, unknown> = BaseAction<
          string,
          unknown,
          unknown,
      >,
  >(
      channelId: A["id"],
      data?: A["request"],
      timeout?: number,
  ): Promise<ClientResponse<A["response"]>>

  Type Parameters

  • A extends BaseAction<string, unknown, unknown> = BaseAction<string, unknown, unknown>

  Parameters

  • channelId: A["id"]
  • Optionaldata: A["request"]
  • timeout: number = 10_000

  Returns Promise<ClientResponse<A["response"]>>