Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / MatchSessionAutoReconnectPolicy

Interface: MatchSessionAutoReconnectPolicy ​

Defined in: packages/ts-sdk/src/match-session/session-state.ts:117

Automatic reconnect policy for abnormal match socket closes.

Example:

ts
import type { MatchSessionAutoReconnectPolicy } from '@my-swu/simulator-client'

const matchSessionAutoReconnectPolicy: MatchSessionAutoReconnectPolicy = {}

console.log(matchSessionAutoReconnectPolicy)

Properties ​

backoffFactor? ​

Example:

ts
import type { MatchSessionAutoReconnectPolicy } from '@my-swu/simulator-client'

const matchSessionAutoReconnectPolicy: MatchSessionAutoReconnectPolicy = {}

const { backoffFactor } = matchSessionAutoReconnectPolicy

console.log(backoffFactor)

optional backoffFactor?: number

Defined in: packages/ts-sdk/src/match-session/session-state.ts:125

Multiplier applied to each subsequent delay.


heartbeat? ​

Example:

ts
import type { MatchSessionAutoReconnectPolicy } from '@my-swu/simulator-client'

const matchSessionAutoReconnectPolicy: MatchSessionAutoReconnectPolicy = {}

const { heartbeat } = matchSessionAutoReconnectPolicy

console.log(heartbeat)

optional heartbeat?: MatchSessionHeartbeatOptions

Defined in: packages/ts-sdk/src/match-session/session-state.ts:130

Detect sockets that remain reported as open after their transport path stops delivering server messages. Enabled by default with auto-reconnect.


initialDelayMs? ​

Example:

ts
import type { MatchSessionAutoReconnectPolicy } from '@my-swu/simulator-client'

const matchSessionAutoReconnectPolicy: MatchSessionAutoReconnectPolicy = {}

const { initialDelayMs } = matchSessionAutoReconnectPolicy

console.log(initialDelayMs)

optional initialDelayMs?: number

Defined in: packages/ts-sdk/src/match-session/session-state.ts:121

Delay before the first retry in milliseconds.


maxDelayMs? ​

Example:

ts
import type { MatchSessionAutoReconnectPolicy } from '@my-swu/simulator-client'

const matchSessionAutoReconnectPolicy: MatchSessionAutoReconnectPolicy = {}

const { maxDelayMs } = matchSessionAutoReconnectPolicy

console.log(maxDelayMs)

optional maxDelayMs?: number

Defined in: packages/ts-sdk/src/match-session/session-state.ts:123

Maximum backoff delay in milliseconds.


maxRetries? ​

Example:

ts
import type { MatchSessionAutoReconnectPolicy } from '@my-swu/simulator-client'

const matchSessionAutoReconnectPolicy: MatchSessionAutoReconnectPolicy = {}

const { maxRetries } = matchSessionAutoReconnectPolicy

console.log(maxRetries)

optional maxRetries?: number

Defined in: packages/ts-sdk/src/match-session/session-state.ts:119

Maximum reconnect attempts before emitting an SDK error.

Released under the MIT License.