startProbe

fun startProbe(intervalMillis: Long = TransportWireFormat.DEFAULT_PROBE_INTERVAL_MILLIS): Result<Unit>(source)

Starts an opt-in link-quality probe: every intervalMillis this client sends one 0x81 probe (an 8-byte big-endian sequence) to the server, and each matching 0x82 reply updates a smoothed RTT / jitter / packet-loss estimate readable via linkQuality. Off until called; runs until stopProbe or stop. Backed by one daemon thread (mcupc-probe) created on the first call. Calling this again re-arms it (last call wins). Call after handshake

  • probes sent before registration go unanswered and register as loss.

The probe requires both ends on webtools-udp 2.0.0+ (as does every framed datagram) - a cross-major peer is rejected at the handshake.

Return

Result.success once armed; Result.failure with IllegalArgumentException if intervalMillis is below the floor, or IllegalStateException if stop has already run.

Parameters

intervalMillis