tauri-plugin-serialplugin-api 2.18.0

package/dist-js/auto-reconnect-manager.d.ts

@@ -0,0 +1,69 @@
+/**
+ * Auto-reconnect manager for serial ports
+ * Handles automatic reconnection logic with configurable settings
+ */
+export declare class AutoReconnectManager {
+    private enabled;
+    private interval;
+    private maxAttempts;
+    private currentAttempts;
+    private timer;
+    private callback?;
+    private reconnectFunction?;
+    /**
+     * @description Enables auto-reconnect functionality
+     * @param {Object} options Auto-reconnect configuration options
+     * @param {number} [options.interval=5000] Reconnection interval in milliseconds
+     * @param {number | null} [options.maxAttempts=10] Maximum number of reconnection attempts (null for infinite)
+     * @param {Function} [options.onReconnect] Callback function called on each reconnection attempt
+     * @param {Function} options.reconnectFunction Function that performs the actual reconnection
+     * @returns {Promise<void>} A promise that resolves when auto-reconnect is enabled
+     */
+    enable(options: {
+        interval?: number;
+        maxAttempts?: number | null;
+        onReconnect?: (success: boolean, attempt: number) => void;
+        reconnectFunction: () => Promise<boolean>;
+    }): Promise<void>;
+    /**
+     * @description Disables auto-reconnect functionality
+     * @returns {Promise<void>} A promise that resolves when auto-reconnect is disabled
+     */
+    disable(): Promise<void>;
+    /**
+     * @description Gets auto-reconnect status and configuration
+     * @returns {Object} Auto-reconnect information
+     */
+    getInfo(): {
+        enabled: boolean;
+        interval: number;
+        maxAttempts: number | null;
+        currentAttempts: number;
+        hasCallback: boolean;
+    };
+    /**
+     * @description Starts the auto-reconnect process
+     * @returns {Promise<void>} A promise that resolves when auto-reconnect process starts
+     */
+    start(): Promise<void>;
+    /**
+     * @description Stops the auto-reconnect process (clears timer but keeps enabled)
+     * @returns {Promise<void>} A promise that resolves when auto-reconnect process stops
+     */
+    stop(): Promise<void>;
+    /**
+     * @description Resets the attempt counter
+     * @returns {Promise<void>} A promise that resolves when counter is reset
+     */
+    reset(): Promise<void>;
+    /**
+     * @description Internal method to perform a single reconnection attempt
+     * @returns {Promise<void>} A promise that resolves when the attempt is complete
+     */
+    private performAttempt;
+    isEnabled(): boolean;
+    getInterval(): number;
+    getMaxAttempts(): number | null;
+    getCurrentAttempts(): number;
+    hasCallback(): boolean;
+}