Skip to content

@my-swu/simulator-client


@my-swu/simulator-client / MatchSessionHeartbeatPolicy

Interface: MatchSessionHeartbeatPolicy ​

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

Settings for the ping/pong liveness check owned by an auto-reconnecting session.

Example:

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

const matchSessionHeartbeatPolicy: MatchSessionHeartbeatPolicy = {}

console.log(matchSessionHeartbeatPolicy)

Properties ​

intervalMs? ​

Example:

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

const matchSessionHeartbeatPolicy: MatchSessionHeartbeatPolicy = {}

const { intervalMs } = matchSessionHeartbeatPolicy

console.log(intervalMs)

optional intervalMs?: number

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

Delay between a successful pong and the next liveness ping.


timeoutMs? ​

Example:

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

const matchSessionHeartbeatPolicy: MatchSessionHeartbeatPolicy = {}

const { timeoutMs } = matchSessionHeartbeatPolicy

console.log(timeoutMs)

optional timeoutMs?: number

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

Maximum time to wait for the matching pong before reconnecting.

Released under the MIT License.