Class Engine

Hierarchy

Engine

Index

Constructors

Properties

CONNECT_INTENT_POST_INTERVAL LOG_THRESH_MS _bufferedAmounts _byteTrackerInterval _bytesReceivedSinceConnect _bytesSentSinceConnect _closeCounts _connected _eventCountsSinceOpen _heartbeatInterval _lastActionSentAt _lastBackupHeartbeatSent _lastBytesReceived _lastBytesSent _lastRegularHeartbeatSent _reconnectionAttempts _sendQ _timeSpentDisconnected clientUid? connectIntentInterval connectMetrics connectionFailedTimeout connectionId connectionInitTime dcLogTimeout debugOverrideHttpServer? debugOverrideServer? disconnectedStartTime getAuth gotFirstMessage hasEverFullyConnected lastSignOfLife lastSuccessfulFetch lastSuspendCheck lastSuspendDate latencies numMoveEventsBuffered preRefreshDcData reconnectTimeout serverURL sizeOfLargestMessageReceived sizeOfNextLargeMessage spaceId startTime started suspendCheckInterval tempInitInfo? tempSpawnToken? tempTargetId? transactionManager uninterruptedLastFullSyncTime uploadLogTimeout uploadLogTimeoutLong userIdForABTest wantsToEnter ws?

Accessors

isOnline isReconnectScheduled reconnectionAttempts

Constructors

constructor

new Engine(spaceId, getAuth, overrideServer?, overrideHttpServer?): Engine
Parameters
- spaceId: string
- getAuth: (() => Promise<EngineAuth>)
  - - (): Promise<EngineAuth>
    - Returns Promise<EngineAuth>
- Optional overrideServer: string
- Optional overrideHttpServer: string
Returns Engine
- Defined in gather-game-client/src/Engine.ts:147

Properties

`Private` CONNECT_INTENT_POST_INTERVAL

CONNECT_INTENT_POST_INTERVAL: number = ...

LOG_THRESH_MS

LOG_THRESH_MS: number = 10000

_bufferedAmounts

_bufferedAmounts: SlidingWindow = ...

`Private` _byteTrackerInterval

_byteTrackerInterval: TimeoutOrUndefined

`Private` _bytesReceivedSinceConnect

_bytesReceivedSinceConnect: number = 0

`Private` _bytesSentSinceConnect

_bytesSentSinceConnect: number = 0

_closeCounts

_closeCounts: {
[code: number]: number;
} = {}

Type declaration

[code: number]: number

_connected

_connected: boolean = false

_eventCountsSinceOpen

_eventCountsSinceOpen: {
[event: string]: number;
} = {}

Type declaration

[event: string]: number

_heartbeatInterval

_heartbeatInterval: TimeoutOrUndefined

`Private` _lastActionSentAt

_lastActionSentAt: number = 0

`Private` _lastBackupHeartbeatSent

_lastBackupHeartbeatSent: number = 0

`Private` _lastBytesReceived

_lastBytesReceived: number = 0

`Private` _lastBytesSent

_lastBytesSent: number = 0

`Private` _lastRegularHeartbeatSent

_lastRegularHeartbeatSent: number = 0

`Private` _reconnectionAttempts

_reconnectionAttempts: number = 0

`Private` _sendQ

_sendQ: {
action: ClientServerActionAction;
txnId?: number;
}[] = []

_timeSpentDisconnected

_timeSpentDisconnected: SlidingWindow = ...

`Optional` clientUid

clientUid?: string

`Private` connectIntentInterval

connectIntentInterval: TimeoutOrUndefined

`Private` connectMetrics

connectMetrics: {
    gotGameServerUrl: number;
    gotReady: number;
    gotSpaceSetsCapacity: number;
    gotSpaceSetsIdMapping: number;
    gotSubscriptionsUpdated: number;
    gotWsOpen: number;
} = ...

Type declaration

gotGameServerUrl: number
gotReady: number
gotSpaceSetsCapacity: number
gotSpaceSetsIdMapping: number
gotSubscriptionsUpdated: number
gotWsOpen: number

`Private` connectionFailedTimeout

connectionFailedTimeout: TimeoutOrUndefined

`Private` connectionId

connectionId: string = ""

`Private` connectionInitTime

connectionInitTime: number = 0

`Private` dcLogTimeout

dcLogTimeout: TimeoutOrUndefined

`Optional` debugOverrideHttpServer

debugOverrideHttpServer?: string

`Optional` debugOverrideServer

debugOverrideServer?: string

`Private` disconnectedStartTime

disconnectedStartTime: number = 0

getAuth

getAuth: (() => Promise<EngineAuth>)

Type declaration

- (): Promise<EngineAuth>
- Returns Promise<EngineAuth>

`Private` gotFirstMessage

gotFirstMessage: boolean = false

`Private` hasEverFullyConnected

hasEverFullyConnected: boolean = false

`Private` lastSignOfLife

lastSignOfLife: number = 0

`Private` lastSuccessfulFetch

lastSuccessfulFetch: number = 0

`Private` lastSuspendCheck

lastSuspendCheck: number = 0

`Private` lastSuspendDate

lastSuspendDate: number = 0

`Private` latencies

latencies: SlidingWindow = ...

`Private` numMoveEventsBuffered

numMoveEventsBuffered: number = 0

`Private` preRefreshDcData

preRefreshDcData: undefined | EngineUnloadDcData = undefined

`Private` reconnectTimeout

reconnectTimeout: TimeoutOrUndefined

serverURL

serverURL: string = ""

`Private` sizeOfLargestMessageReceived

sizeOfLargestMessageReceived: number = 0

`Private` sizeOfNextLargeMessage

sizeOfNextLargeMessage: number = 0

spaceId

spaceId: string

`Private` startTime

startTime: number = 0

`Private` started

started: boolean = false

`Private` suspendCheckInterval

suspendCheckInterval: TimeoutOrUndefined

`Private` `Optional` tempInitInfo

tempInitInfo?: PlayerInitInfo

`Private` `Optional` tempSpawnToken

tempSpawnToken?: string

`Private` `Optional` tempTargetId

tempTargetId?: string

`Private` transactionManager

transactionManager: TransactionManager = ...

`Private` uninterruptedLastFullSyncTime

uninterruptedLastFullSyncTime: number = 0

`Private` uploadLogTimeout

uploadLogTimeout: TimeoutOrUndefined

`Private` uploadLogTimeoutLong

uploadLogTimeoutLong: TimeoutOrUndefined

`Private` `Readonly` userIdForABTest

userIdForABTest: string = ""

`Private` wantsToEnter

wantsToEnter: boolean = false

action/event handling **

`Optional` ws

ws?: WebSocket

Accessors

`Private` isOnline

get isOnline(): boolean
Returns boolean
- Defined in gather-game-client/src/Engine.ts:273

isReconnectScheduled

get isReconnectScheduled(): boolean
Returns boolean
- Defined in gather-game-client/src/Engine.ts:649

reconnectionAttempts

get reconnectionAttempts(): number
Returns number
- Defined in gather-game-client/src/Engine.ts:653

Methods

`Private` abortConnectionAttempt

abortConnectionAttempt(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:113

checkAndHandleSuspend

checkAndHandleSuspend(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1304

`Private` cleanUpAndQueueReconnect

cleanUpAndQueueReconnect(disconnectInfo?): void
Parameters
- Optional disconnectInfo: DisconnectInfo
Returns void
- Defined in gather-game-client/src/Engine.ts:661

`Private` clearUnloadDcState

clearUnloadDcState(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:210

`Private` createConnection

createConnection(reuseServerURL?): Promise<void>
Parameters
- reuseServerURL: boolean = false
Returns Promise<void>
- Defined in gather-game-client/src/Engine.ts:293

`Private` destroyConnection

destroyConnection(disconnectInfo?): void
Parameters
- Optional disconnectInfo: DisconnectInfo
Returns void
- Defined in gather-game-client/src/Engine.ts:586

exit

exit(useTxn?): void | Promise<unknown>
Parameters
- useTxn: boolean = false
Returns void | Promise<unknown>
- Defined in gather-game-client/src/Engine.ts:796

`Private` getAuthWithAbort

getAuthWithAbort(signal): Promise<null | EngineAuth>
Parameters
- signal: AbortSignal
Returns Promise<null | EngineAuth>
- Defined in gather-game-client/src/Engine.ts:278

getBaseMetricsInfo

getBaseMetricsInfo(): {
connectionId: string;
serverUrl: string;
}
- UTILS **
Returns {
connectionId: string;
serverUrl: string;
}
- connectionId: string
- serverUrl: string
- Defined in gather-game-client/src/Engine.ts:1336

`Private` getGameServerUrl

getGameServerUrl(signal): Promise<null | string>
Returns the serverURL for the spaceId or null in case of timeout/error
Parameters
- signal: AbortSignal
Returns Promise<null | string>
- Defined in gather-game-client/src/Engine.ts:1347

getMetrics

getMetrics(): {
    bufferedAmount: SlidingWindowMetrics;
    bytesReceivedSinceConnect: number;
    bytesSentSinceConnect: number;
    closeCodeCount: {
        [code: number]: number;
    };
    connected: boolean;
    eventCountsSinceOpen: {
        [event: string]: number;
    };
    latency: SlidingWindowMetrics;
    reconnects: {
        recentAttempts: number;
        timeSpentDisconnectedMs: SlidingWindowMetrics;
    };
}
Returns {
    bufferedAmount: SlidingWindowMetrics;
    bytesReceivedSinceConnect: number;
    bytesSentSinceConnect: number;
    closeCodeCount: {
        [code: number]: number;
    };
    connected: boolean;
    eventCountsSinceOpen: {
        [event: string]: number;
    };
    latency: SlidingWindowMetrics;
    reconnects: {
        recentAttempts: number;
        timeSpentDisconnectedMs: SlidingWindowMetrics;
    };
}
- bufferedAmount: SlidingWindowMetrics
- bytesReceivedSinceConnect: number
- bytesSentSinceConnect: number
- closeCodeCount: {
  [code: number]: number;
  }
  - [code: number]: number
- connected: boolean
- eventCountsSinceOpen: {
  [event: string]: number;
  }
  - [event: string]: number
- latency: SlidingWindowMetrics
- reconnects: {
  recentAttempts: number;
  timeSpentDisconnectedMs: SlidingWindowMetrics;
  }
  - recentAttempts: number
  - timeSpentDisconnectedMs: SlidingWindowMetrics
- Defined in gather-game-client/src/Engine.ts:1395

`Private` loadUnloadDcState

loadUnloadDcState(): void
try to load the last disconnected unload state to detect whether the user refreshed their browser

Returns void
- Defined in gather-game-client/src/Engine.ts:196

logDisconnectionStart

logDisconnectionStart(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1153

logInitialSyncComplete

logInitialSyncComplete(isPartialSubscribe): void
Parameters
- isPartialSubscribe: boolean
Returns void
- Defined in gather-game-client/src/Engine.ts:1173

onconnect

onconnect(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:140

ondisconnect

ondisconnect(_code?, _reason?): void
Parameters
- Optional _code: number
- Optional _reason: string
Returns void
- Defined in gather-game-client/src/Engine.ts:141

onevent

onevent(_e): void
Parameters
- _e: ServerClientEvent
Returns void
- Defined in gather-game-client/src/Engine.ts:139

onmetric

onmetric(_metricName, _metricValue): void
Parameters
- _metricName: string
- _metricValue: unknown
Returns void
- Defined in gather-game-client/src/Engine.ts:142

`Private` processEvent

processEvent(serverClientEvent): void
Parameters
- serverClientEvent: ServerClientEvent
Returns void
- Defined in gather-game-client/src/Engine.ts:808

queueDebugUpload

queueDebugUpload(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1258

queueOrExecuteEnter

queueOrExecuteEnter(info?, spawnToken?, targetId?): void
Parameters
- Optional info: PlayerInitInfo
- Optional spawnToken: string
- Optional targetId: string
Returns void
- Defined in gather-game-client/src/Engine.ts:762

`Private` recordHeartbeatTime

recordHeartbeatTime(time): void
- MONITORING **
Parameters
- time: number
Returns void
- Defined in gather-game-client/src/Engine.ts:991

redirectToProdIfOnProdServer

redirectToProdIfOnProdServer(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1411

resetDisconnectionTracking

resetDisconnectionTracking(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1238

`Private` saveUnloadDcState

saveUnloadDcState(): void
if we're disconnected write to local storage so we can detect browser refresh fixes

Returns void
- Defined in gather-game-client/src/Engine.ts:175

sendAction

sendAction(action, bypass, createTxnId, txnId, txnTimeout?): Promise<unknown>
Parameters
- action: ClientServerActionAction
- bypass: boolean
- createTxnId: true
- txnId: undefined
- Optional txnTimeout: number
Returns Promise<unknown>
A promise if createTxnId is true, otherwise nothing.
- Defined in gather-game-client/src/Engine.ts:901
sendAction(action, bypass?, createTxnId?, txnId?, txnTimeout?): void
Parameters
- action: ClientServerActionAction
- Optional bypass: boolean
- Optional createTxnId: false
- Optional txnId: number
- Optional txnTimeout: number
Returns void
- Defined in gather-game-client/src/Engine.ts:908
sendAction(action, bypass?, createTxnId?, txnId?, txnTimeout?): void | Promise<unknown>
Parameters
- action: ClientServerActionAction
- Optional bypass: boolean
- Optional createTxnId: boolean
- Optional txnId: number
- Optional txnTimeout: number
Returns void | Promise<unknown>
- Defined in gather-game-client/src/Engine.ts:915

`Private` sendBackupHeartbeat

sendBackupHeartbeat(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1004

start

start(): void
CONNECTION LOGIC

lifecycle is now:
- start / stop -- for making the engine do anything at all
- createConnection / destroyConnection -- internal to engine. for managing the specific connection at any given time
- cleanUpAndQueueReconnect -- for reconnects
connection attempt flow (in this.createConnection):
- fetch game server assignment (ws url) from https://api.gather.town/api/v2/spaces/${spaceId}/game-server-assignment
- open ws connection to that^ url (e.g. wss://game-aaai-xxx.gather.town:443)
- connection opens successfully
- receive all init data (maps and players) if any of those steps fail, we reset everything, wait an exponential backoff, and try again
reconnect/retry safeguards:
- if the connection closes, clean up (destroy) and queue reconnect
- start a timeout when you first try to connect, cancel it when you get the first message. destroys and queues reconnect if it goes off (MAX_WAIT_FOR_CONNECTION)
- start a heartbeat when you open the connection. if you don't hear anything for a while, destroy and queue reconnect (HEARTBEAT_TIMEOUT)
- cleanUpAndQueueReconnect sets a timeout to create a new connection, if one doesn't exist already
  - timeout length increases (up to MAX_RECONNECT_DELAY) each time until it's been a while (RESET_RECONNECT_ATTEMPTS_DELAY) since last call to reconnect
Returns void
- Defined in gather-game-client/src/Engine.ts:245

startByteTracker

startByteTracker(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1062

startHeartbeat

startHeartbeat(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1018

`Private` startRecordingIntentToConnect

startRecordingIntentToConnect(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1096

startSuspendCheck

startSuspendCheck(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1320

stop

stop(disconnectInfo?): void
Parameters
- Optional disconnectInfo: DisconnectInfo
Returns void
- Defined in gather-game-client/src/Engine.ts:257

stopByteTracker

stopByteTracker(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1085

stopHeartbeat

stopHeartbeat(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1051

`Private` stopRecordingIntentToConnect

stopRecordingIntentToConnect(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1116

stopSuspendCheck

stopSuspendCheck(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:1328

subscriptionHook

subscriptionHook(): void
Returns void
- Defined in gather-game-client/src/Engine.ts:143

`Private` trackRefreshFixedConnectionIssue

trackRefreshFixedConnectionIssue(fixed): void
Parameters
- fixed: boolean
Returns void
- Defined in gather-game-client/src/Engine.ts:1120

Class Engine

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

spaceId: string

getAuth: (() => Promise<EngineAuth>)

Returns Promise<EngineAuth>

Optional overrideServer: string

Optional overrideHttpServer: string

Returns Engine

Properties

Private CONNECT_INTENT_POST_INTERVAL

LOG_THRESH_MS

_bufferedAmounts

Private _byteTrackerInterval

Private _bytesReceivedSinceConnect

Private _bytesSentSinceConnect

_closeCounts

Type declaration

[code: number]: number

_connected

_eventCountsSinceOpen

Type declaration

[event: string]: number

_heartbeatInterval

Private _lastActionSentAt

Private _lastBackupHeartbeatSent

Private _lastBytesReceived

Private _lastBytesSent

Private _lastRegularHeartbeatSent

Private _reconnectionAttempts

Private _sendQ

_timeSpentDisconnected

Optional clientUid

Private connectIntentInterval

Private connectMetrics

Type declaration

gotGameServerUrl: number

gotReady: number

gotSpaceSetsCapacity: number

gotSpaceSetsIdMapping: number

gotSubscriptionsUpdated: number

gotWsOpen: number

Private connectionFailedTimeout

Private connectionId

Private connectionInitTime

Private dcLogTimeout

Optional debugOverrideHttpServer

Optional debugOverrideServer

Private disconnectedStartTime

getAuth

Type declaration

Returns Promise<EngineAuth>

Private gotFirstMessage

Private hasEverFullyConnected

Private lastSignOfLife

Private lastSuccessfulFetch

Private lastSuspendCheck

Private lastSuspendDate

Private latencies

Private numMoveEventsBuffered

Private preRefreshDcData

Private reconnectTimeout

serverURL

Private sizeOfLargestMessageReceived

Private sizeOfNextLargeMessage

spaceId

Private startTime

Private started

Private suspendCheckInterval

Private Optional tempInitInfo

Private Optional tempSpawnToken

Private Optional tempTargetId

Private transactionManager

`Optional` overrideServer: string

`Optional` overrideHttpServer: string

`Private` CONNECT_INTENT_POST_INTERVAL

`Private` _byteTrackerInterval

`Private` _bytesReceivedSinceConnect

`Private` _bytesSentSinceConnect

`Private` _lastActionSentAt

`Private` _lastBackupHeartbeatSent

`Private` _lastBytesReceived

`Private` _lastBytesSent

`Private` _lastRegularHeartbeatSent

`Private` _reconnectionAttempts

`Private` _sendQ

`Optional` clientUid

`Private` connectIntentInterval

`Private` connectMetrics

`Private` connectionFailedTimeout

`Private` connectionId

`Private` connectionInitTime

`Private` dcLogTimeout

`Optional` debugOverrideHttpServer

`Optional` debugOverrideServer

`Private` disconnectedStartTime

`Private` gotFirstMessage

`Private` hasEverFullyConnected

`Private` lastSignOfLife

`Private` lastSuccessfulFetch

`Private` lastSuspendCheck

`Private` lastSuspendDate

`Private` latencies

`Private` numMoveEventsBuffered

`Private` preRefreshDcData

`Private` reconnectTimeout

`Private` sizeOfLargestMessageReceived

`Private` sizeOfNextLargeMessage

`Private` startTime

`Private` started

`Private` suspendCheckInterval

`Private` `Optional` tempInitInfo

`Private` `Optional` tempSpawnToken

`Private` `Optional` tempTargetId

`Private` transactionManager

`Private` uninterruptedLastFullSyncTime

`Private` uploadLogTimeout

`Private` uploadLogTimeoutLong

`Private` `Readonly` userIdForABTest

`Private` wantsToEnter

`Optional` ws

`Private` isOnline

`Private` abortConnectionAttempt

`Private` cleanUpAndQueueReconnect

`Optional` disconnectInfo: DisconnectInfo

`Private` clearUnloadDcState

`Private` createConnection

`Private` destroyConnection

`Optional` disconnectInfo: DisconnectInfo

`Private` getAuthWithAbort

Returns {
connectionId: string;
serverUrl: string;
}

`Private` getGameServerUrl

closeCodeCount: {
[code: number]: number;
}

eventCountsSinceOpen: {
[event: string]: number;
}

reconnects: {
recentAttempts: number;
timeSpentDisconnectedMs: SlidingWindowMetrics;
}

`Private` loadUnloadDcState