@my-swu/simulator-client

---

@my-swu/simulator-client / pingMessage

Function: pingMessage()

pingMessage(nonce?): ClientMessage

Defined in: packages/ts-sdk/src/messages.ts:57

Builds one ping socket message.

The optional nonce is echoed by the server pong frame, which lets clients measure round-trip latency.

Example:

import { pingMessage } from '@my-swu/simulator-client'

// Nonces are echoed by pong messages for latency measurements.
const clientMessage = pingMessage('host-latency-1')

console.log(clientMessage.type)

Parameters

nonce?

Example:

import { pingMessage } from '@my-swu/simulator-client'

// Nonces are echoed by pong messages for latency measurements.
const clientMessage = pingMessage('host-latency-1')

console.log(clientMessage.type)

string | null

Returns

ClientMessage

Example

import { pingMessage } from '@my-swu/simulator-client'

const clientMessage = pingMessage('latency-check-1')
console.log(clientMessage.type)

See

https://simulator-sdk.my-swu.com/guide/websocket