@pajn/node-tradfri-client/build/lib/watcher.d.ts

Library to talk to IKEA Trådfri Gateways without external binaries

/// <reference types="node" />
import { EventEmitter } from "events";
import { TradfriClient } from "..";
import { ConnectionWatcherEventCallbacks, ConnectionWatcherEvents } from "./events";
/** Configures options for connection watching and automatic reconnection */
export interface ConnectionWatcherOptions {
    /** The interval in ms between consecutive pings */
    pingInterval: number;
    /** How many pings have to consecutively fail until the gateway is assumed offline */
    failedPingCountUntilOffline: number;
    /**
     * How much the interval between consecutive pings should be increased while the gateway is offline.
     * The actual interval is calculated by <ping interval> * <backoff factor> ** <min(5, # offline pings)>
     */
    failedPingBackoffFactor: number;
    /** Whether automatic reconnection is enabled */
    reconnectionEnabled: boolean;
    /** How many pings have to consecutively fail while the gateway is offline until a reconnection is triggered */
    offlinePingCountUntilReconnect: number;
    /** After how many failed reconnects we give up. Number.POSITIVE_INFINITY to never gonna give you up, never gonna let you down... */
    maximumReconnects: number;
    /** How many tries for the initial connection should be attempted */
    maximumConnectionAttempts: number;
    /** The interval in ms between consecutive connection attempts */
    connectionInterval: number;
    /**
     * How much the interval between consecutive connection attempts should be increased.
     * The actual interval is calculated by <connection interval> * <backoff factor> ** <min(5, # failed attempts)>
     */
    failedConnectionBackoffFactor: number;
}
export interface ConnectionWatcher {
    on<TEvent extends ConnectionWatcherEvents>(event: TEvent, callback: ConnectionWatcherEventCallbacks[TEvent]): this;
    removeListener<TEvent extends ConnectionWatcherEvents>(event: TEvent, callback: ConnectionWatcherEventCallbacks[TEvent]): this;
    removeAllListeners(event?: ConnectionWatcherEvents): this;
}
/**
 * Watches the connection of a TradfriClient and notifies about changes in the connection state
 */
export declare class ConnectionWatcher extends EventEmitter {
    private client;
    constructor(client: TradfriClient, options?: Partial<ConnectionWatcherOptions>);
    private _options;
    get options(): ConnectionWatcherOptions;
    private pingTimer;
    /** Starts watching the connection */
    start(): void;
    private isActive;
    /** Stops watching the connection */
    stop(): void;
    private connectionAlive;
    private failedPingCount;
    private offlinePingCount;
    private resetAttempts;
    private pingThread;
}