@robotical/raftjs 1.3.3

package/src/RaftCommsStats.ts

@@ -0,0 +1,142 @@
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RaftCommStats
+// Part of RaftJS
+//
+// Rob Dobson & Chris Greening 2020-2024
+// (C) 2020-2024 All rights reserved
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export default class RaftCommsStats {
+  _msgRxCount = 0;
+  _msgRxCountInWindow = 0;
+  _msgRxLastCalcMs = 0;
+  _msgRxRate = 0;
+  _msgTooShort = 0;
+  _msgTxCount = 0;
+  _msgTxCountInWindow = 0;
+  _msgTxLastCalcMs = 0;
+  _msgTxRate = 0;
+  _msgNumCollisions = 0;
+  _msgNumUnmatched = 0;
+  _msgRoundtripWorstMs = 0;
+  _msgRoundtripBestMs = 0;
+  _msgRoundtripLastMs = 0;
+  _msgTimeout = 0;
+  _msgRetry = 0;
+
+  _msgNoConnection = 0;
+  _streamBytes = 0;
+  _fileBytes = 0;
+
+  clear() {
+    this._msgRxCount = 0;
+    this._msgRxCountInWindow = 0;
+    this._msgRxLastCalcMs = Date.now();
+    this._msgRxRate = 0;
+    this._msgTooShort = 0;
+    this._msgTxCount = 0;
+    this._msgTxCountInWindow = 0;
+    this._msgTxLastCalcMs = Date.now();
+    this._msgTxRate = 0;
+    this._msgNumCollisions = 0;
+    this._msgNumUnmatched = 0;
+    this._msgRoundtripBestMs = 0;
+    this._msgRoundtripWorstMs = 0;
+    this._msgRoundtripLastMs = 0;
+    this._msgTimeout = 0;
+    this._msgRetry = 0;
+    this._msgNoConnection = 0;
+    this._streamBytes = 0;
+    this._fileBytes = 0;
+  }
+
+  msgRx(): void {
+    this._msgRxCount++;
+    this._msgRxCountInWindow++;
+  }
+
+  getMsgRxRate(): number {
+    if (this._msgRxLastCalcMs + 1000 < Date.now()) {
+      this._msgRxRate =
+        (1000.0 * this._msgRxCountInWindow) /
+        (Date.now() - this._msgRxLastCalcMs);
+      this._msgRxLastCalcMs = Date.now();
+      this._msgRxCountInWindow = 0;
+    }
+    return this._msgRxRate;
+  }
+
+  msgTooShort(): void {
+    this._msgTooShort++;
+  }
+
+  msgTx(): void {
+    this._msgTxCount++;
+    this._msgTxCountInWindow++;
+  }
+
+  getMsgTxRate(): number {
+    if (this._msgTxLastCalcMs + 1000 < Date.now()) {
+      this._msgTxRate =
+        (1000.0 * this._msgTxCountInWindow) /
+        (Date.now() - this._msgTxLastCalcMs);
+      this._msgTxLastCalcMs = Date.now();
+      this._msgTxCountInWindow = 0;
+    }
+    return this._msgTxRate;
+  }
+
+  getRTWorstMs(): number {
+    return this._msgRoundtripWorstMs;
+  }
+
+  getRTLastMs(): number {
+    return this._msgRoundtripLastMs;
+  }
+
+  getRTBestMs(): number {
+    return this._msgRoundtripBestMs;
+  }
+
+  getRetries(): number {
+    return this._msgRetry;
+  }
+
+  recordMsgNumCollision(): void {
+    this._msgNumCollisions++;
+  }
+
+  recordMsgNumUnmatched(): void {
+    this._msgNumUnmatched++;
+  }
+
+  recordMsgResp(roundTripMs: number): void {
+    if (this._msgRoundtripWorstMs < roundTripMs)
+      this._msgRoundtripWorstMs = roundTripMs;
+    if (this._msgRoundtripBestMs == 0 || this._msgRoundtripBestMs > roundTripMs)
+      this._msgRoundtripBestMs = roundTripMs;
+    this._msgRoundtripLastMs = roundTripMs;
+  }
+
+  recordMsgTimeout(): void {
+    this._msgTimeout++;
+  }
+
+  recordMsgNoConnection(): void {
+    this._msgNoConnection++;
+  }
+
+  recordMsgRetry(): void {
+    this._msgRetry++;
+  }
+
+  recordStreamBytes(bytes: number): void {
+    this._streamBytes += bytes;
+  }
+
+  recordFileBytes(bytes: number): void {
+    this._fileBytes += bytes;
+  }
+}

package/src/RaftConnEvents.ts

@@ -0,0 +1,58 @@
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+//
+// RaftConnEvents
+// Part of RaftJS
+//
+// Rob Dobson & Chris Greening 2020-2024
+// (C) 2020-2024 All rights reserved
+//
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+export enum RaftConnEvent {
+    CONN_CONNECTING,
+    CONN_CONNECTED,
+    CONN_CONNECTION_FAILED,
+    CONN_DISCONNECTED,
+    CONN_REJECTED,
+    CONN_ISSUE_DETECTED,
+    CONN_ISSUE_RESOLVED,
+    CONN_VERIFYING_CORRECT,
+    CONN_VERIFIED_CORRECT,
+    CONN_GETTING_INFO,
+    CONN_GOT_INFO,
+    CONN_BLUETOOTH_STATE,
+    CONN_STREAMING_ISSUE,
+
+    // PHONE_BLE_ONLY
+    BLE_SCANNING_STARTED,
+    BLE_DEVICE_FOUND,
+    BLE_SCANNING_FINISHED,
+    BLE_BLUETOOTH_STATE,
+}
+
+export const RaftConnEventNames = {
+    [RaftConnEvent.CONN_CONNECTING]: 'CONNECTING',
+    [RaftConnEvent.CONN_CONNECTED]: 'CONNECTED',
+    [RaftConnEvent.CONN_CONNECTION_FAILED]: 'CONNECTION_FAILED',
+    [RaftConnEvent.CONN_DISCONNECTED]: 'DISCONNECTED',
+    [RaftConnEvent.CONN_REJECTED]: 'REJECTED',
+    [RaftConnEvent.CONN_ISSUE_DETECTED]: 'ISSUE_DETECTED',
+    [RaftConnEvent.CONN_ISSUE_RESOLVED]: 'ISSUE_RESOLVED',
+    [RaftConnEvent.CONN_VERIFYING_CORRECT]: 'VERIFYING_CORRECT',
+    [RaftConnEvent.CONN_VERIFIED_CORRECT]: 'VERIFIED_CORRECT',
+    [RaftConnEvent.CONN_GETTING_INFO]: 'GETTING_INFO',
+    [RaftConnEvent.CONN_GOT_INFO]: 'GOT_INFO',
+    [RaftConnEvent.CONN_BLUETOOTH_STATE]: 'BLUETOOTH_STATE',
+    [RaftConnEvent.CONN_STREAMING_ISSUE]: 'STREAMING_ISSUE',
+
+    // PHONE_BLE_ONLY
+    [RaftConnEvent.BLE_SCANNING_STARTED]: 'BLE_SCANNING_STARTED',
+    [RaftConnEvent.BLE_DEVICE_FOUND]: 'BLE_DEVICE_FOUND',
+    [RaftConnEvent.BLE_SCANNING_FINISHED]: 'BLE_SCANNING_FINISHED',
+    [RaftConnEvent.BLE_BLUETOOTH_STATE]: 'BLE_BLUETOOTH_STATE',
+};
+  
+export type RaftConnEventFn = (
+  eventType: RaftConnEvent,
+  data?: any | string[] | string | null,
+) => void;