matssocket/dist/PingPong.d.ts

MatsSocket client library

/**
 * Fractional milliseconds for high-res timing.
 */
export type FractionalMillis = number;
/**
 * Timestamp, millis-since-epoch.
 */
export type Timestamp = number;
/**
 * (Metric) A "holding struct" for pings and their experienced round-trip times - you may "subscribe" to ping results
 * using {@link MatsSocket#addPingPongListener()}, and you may get the latest pings from the property
 * {@link MatsSocket#pings}.
 *
 * @param {number} pingId
 * @param {Timestamp} sentTimestamp
 * @class
 */
export function PingPong(pingId: number, sentTimestamp: Timestamp): void;
export class PingPong {
    /**
     * (Metric) A "holding struct" for pings and their experienced round-trip times - you may "subscribe" to ping results
     * using {@link MatsSocket#addPingPongListener()}, and you may get the latest pings from the property
     * {@link MatsSocket#pings}.
     *
     * @param {number} pingId
     * @param {Timestamp} sentTimestamp
     * @class
     */
    constructor(pingId: number, sentTimestamp: Timestamp);
    /**
     * Sequence of the ping.
     *
     * @type {number}
     */
    pingId: number;
    /**
     * Millis-from-epoch when this ping was sent.
     *
     * @type {Timestamp}
     */
    sentTimestamp: Timestamp;
    /**
     * The experienced round-trip time for this ping-pong - this is the time back-and-forth.
     *
     * @type {FractionalMillis}
     */
    roundTripMillis: FractionalMillis;
}
//# sourceMappingURL=PingPong.d.ts.map