node-opcua-client 2.75.0 → 2.76.0

package/dist/client_session.js

@@ -1,11 +1,11 @@
-"use strict";
-/**
- * @module node-opcua-client
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExtensionObject = exports.ExtraDataTypeManager = void 0;
-var node_opcua_client_dynamic_extension_object_1 = require("node-opcua-client-dynamic-extension-object");
-Object.defineProperty(exports, "ExtraDataTypeManager", { enumerable: true, get: function () { return node_opcua_client_dynamic_extension_object_1.ExtraDataTypeManager; } });
-var node_opcua_extension_object_1 = require("node-opcua-extension-object");
-Object.defineProperty(exports, "ExtensionObject", { enumerable: true, get: function () { return node_opcua_extension_object_1.ExtensionObject; } });
+"use strict";
+/**
+ * @module node-opcua-client
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtensionObject = exports.ExtraDataTypeManager = void 0;
+var node_opcua_client_dynamic_extension_object_1 = require("node-opcua-client-dynamic-extension-object");
+Object.defineProperty(exports, "ExtraDataTypeManager", { enumerable: true, get: function () { return node_opcua_client_dynamic_extension_object_1.ExtraDataTypeManager; } });
+var node_opcua_extension_object_1 = require("node-opcua-extension-object");
+Object.defineProperty(exports, "ExtensionObject", { enumerable: true, get: function () { return node_opcua_extension_object_1.ExtensionObject; } });
 //# sourceMappingURL=client_session.js.map

package/dist/client_session_keepalive_manager.d.ts

@@ -1,34 +1,34 @@
-/// <reference types="node" />
-/**
- * @module node-opcua-client
- */
-import { EventEmitter } from "events";
-import { ServerState } from "node-opcua-common";
-import { ClientSessionImpl } from "./private/client_session_impl";
-export interface ClientSessionKeepAliveManagerEvents {
-    on(event: "keepalive", eventHandler: (lastKnownServerState: ServerState, count: number) => void): this;
-    on(event: "failure", eventHandler: () => void): this;
-}
-export declare class ClientSessionKeepAliveManager extends EventEmitter implements ClientSessionKeepAliveManagerEvents {
-    private readonly session;
-    private timerId?;
-    private pingTimeout;
-    private lastKnownState?;
-    private checkInterval;
-    private transactionInProgress;
-    count: number;
-    constructor(session: ClientSessionImpl);
-    start(): void;
-    stop(): void;
-    private ping_server;
-    /**
-     * @method ping_server
-     * @internal
-     * when a session is opened on a server, the client shall send request on a regular basis otherwise the server
-     * session object might time out.
-     * start_ping make sure that ping_server is called on a regular basis to prevent session to timeout.
-     *
-     * @param callback
-     */
-    private _ping_server;
-}
+/// <reference types="node" />
+/**
+ * @module node-opcua-client
+ */
+import { EventEmitter } from "events";
+import { ServerState } from "node-opcua-common";
+import { ClientSessionImpl } from "./private/client_session_impl";
+export interface ClientSessionKeepAliveManagerEvents {
+    on(event: "keepalive", eventHandler: (lastKnownServerState: ServerState, count: number) => void): this;
+    on(event: "failure", eventHandler: () => void): this;
+}
+export declare class ClientSessionKeepAliveManager extends EventEmitter implements ClientSessionKeepAliveManagerEvents {
+    private readonly session;
+    private timerId?;
+    private pingTimeout;
+    private lastKnownState?;
+    private checkInterval;
+    private transactionInProgress;
+    count: number;
+    constructor(session: ClientSessionImpl);
+    start(): void;
+    stop(): void;
+    private ping_server;
+    /**
+     * @method ping_server
+     * @internal
+     * when a session is opened on a server, the client shall send request on a regular basis otherwise the server
+     * session object might time out.
+     * start_ping make sure that ping_server is called on a regular basis to prevent session to timeout.
+     *
+     * @param callback
+     */
+    private _ping_server;
+}

package/dist/client_session_keepalive_manager.js

@@ -1,151 +1,151 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ClientSessionKeepAliveManager = void 0;
-/**
- * @module node-opcua-client
- */
-const events_1 = require("events");
-const chalk = require("chalk");
-const node_opcua_assert_1 = require("node-opcua-assert");
-const node_opcua_common_1 = require("node-opcua-common");
-const node_opcua_constants_1 = require("node-opcua-constants");
-const node_opcua_debug_1 = require("node-opcua-debug");
-const node_opcua_nodeid_1 = require("node-opcua-nodeid");
-const node_opcua_status_code_1 = require("node-opcua-status-code");
-const serverStatusStateNodeId = (0, node_opcua_nodeid_1.coerceNodeId)(node_opcua_constants_1.VariableIds.Server_ServerStatus_State);
-const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
-const doDebug = (0, node_opcua_debug_1.checkDebugFlag)(__filename);
-const warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
-class ClientSessionKeepAliveManager extends events_1.EventEmitter {
-    constructor(session) {
-        super();
-        this.transactionInProgress = false;
-        this.count = 0;
-        this.session = session;
-        this.timerId = undefined;
-        this.pingTimeout = 0;
-        this.checkInterval = 0;
-        this.count = 0;
-    }
-    start() {
-        (0, node_opcua_assert_1.assert)(!this.timerId);
-        /* istanbul ignore next*/
-        if (this.session.timeout < 600) {
-            warningLog(`[NODE-OPCUA-W13] ClientSessionKeepAliveManager detected that the session timeout (${this.session.timeout} ms) is really too small: please adjust it to a greater value ( at least 1000))`);
-        }
-        /* istanbul ignore next*/
-        if (this.session.timeout < 100) {
-            throw new Error(`ClientSessionKeepAliveManager detected that the session timeout (${this.session.timeout} ms) is really too small: please adjust it to a greater value ( at least 1000))`);
-        }
-        this.pingTimeout = Math.min(this.session.timeout / 3, 20000);
-        this.checkInterval = Math.max(50, Math.min((this.session.timeout * 2) / 3, 20000));
-        // make sure first one is almost immediate
-        this.timerId = setTimeout(() => this.ping_server(), this.pingTimeout);
-    }
-    stop() {
-        if (this.timerId) {
-            debugLog("ClientSessionKeepAliveManager#stop");
-            clearTimeout(this.timerId);
-            this.timerId = undefined;
-        }
-        else {
-            debugLog("warning ClientSessionKeepAliveManager#stop ignore (already stopped)");
-        }
-    }
-    ping_server() {
-        this._ping_server().then((delta) => {
-            if (!this.session || this.session.hasBeenClosed()) {
-                return; // stop here
-            }
-            if (this.timerId) {
-                const timeout = Math.max(1, this.checkInterval - delta);
-                this.timerId = setTimeout(() => this.ping_server(), timeout);
-            }
-        });
-    }
-    /**
-     * @method ping_server
-     * @internal
-     * when a session is opened on a server, the client shall send request on a regular basis otherwise the server
-     * session object might time out.
-     * start_ping make sure that ping_server is called on a regular basis to prevent session to timeout.
-     *
-     * @param callback
-     */
-    _ping_server() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const session = this.session;
-            if (!session || session.isReconnecting) {
-                debugLog("ClientSessionKeepAliveManager#ping_server => no session available");
-                return 0;
-            }
-            if (!this.timerId) {
-                return 0; // keep-alive has been canceled ....
-            }
-            const now = Date.now(); // getCurrentClock().timestamp.getTime();
-            const timeSinceLastServerContact = now - session.lastResponseReceivedTime.getTime();
-            if (timeSinceLastServerContact < this.pingTimeout) {
-                debugLog("ClientSessionKeepAliveManager#ping_server skipped because last communication with server was not that long ago ping timeout=", Math.round(this.pingTimeout), "timeSinceLastServerContact  = ", timeSinceLastServerContact);
-                // no need to send a ping yet
-                // console.log("Skipping ",timeSinceLastServerContact,this.session.timeout);
-                return timeSinceLastServerContact - this.pingTimeout;
-            }
-            if (session.isReconnecting) {
-                debugLog("ClientSessionKeepAliveManager#ping_server skipped because client is reconnecting");
-                return 0;
-            }
-            if (session.hasBeenClosed()) {
-                debugLog("ClientSessionKeepAliveManager#ping_server skipped because client is reconnecting");
-                return 0;
-            }
-            debugLog("ClientSessionKeepAliveManager#ping_server timeSinceLastServerContact=", timeSinceLastServerContact, "timeout", this.session.timeout);
-            if (this.transactionInProgress) {
-                // readVariable already taking place ! Ignore
-                return 0;
-            }
-            this.transactionInProgress = true;
-            // Server_ServerStatus_State
-            return new Promise((resolve) => {
-                session.readVariableValue(serverStatusStateNodeId, (err, dataValue) => {
-                    this.transactionInProgress = false;
-                    if (err || !dataValue || !dataValue.value) {
-                        if (err) {
-                            warningLog(chalk.cyan(" warning : ClientSessionKeepAliveManager#ping_server "), chalk.yellow(err.message));
-                        }
-                        /**
-                         * @event failure
-                         * raised when the server is not responding or is responding with en error to
-                         * the keep alive read Variable value transaction
-                         */
-                        this.emit("failure");
-                        resolve(0);
-                        return;
-                    }
-                    if (dataValue.statusCode === node_opcua_status_code_1.StatusCodes.Good) {
-                        const newState = dataValue.value.value;
-                        // istanbul ignore next
-                        if (newState !== this.lastKnownState && this.lastKnownState) {
-                            warningLog("ClientSessionKeepAliveManager#Server state has changed = ", node_opcua_common_1.ServerState[newState], " was ", node_opcua_common_1.ServerState[this.lastKnownState]);
-                        }
-                        this.lastKnownState = newState;
-                        this.count++; // increase successful counter
-                    }
-                    debugLog("emit keepalive");
-                    this.emit("keepalive", this.lastKnownState, this.count);
-                    resolve(0);
-                });
-            });
-        });
-    }
-}
-exports.ClientSessionKeepAliveManager = ClientSessionKeepAliveManager;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ClientSessionKeepAliveManager = void 0;
+/**
+ * @module node-opcua-client
+ */
+const events_1 = require("events");
+const chalk = require("chalk");
+const node_opcua_assert_1 = require("node-opcua-assert");
+const node_opcua_common_1 = require("node-opcua-common");
+const node_opcua_constants_1 = require("node-opcua-constants");
+const node_opcua_debug_1 = require("node-opcua-debug");
+const node_opcua_nodeid_1 = require("node-opcua-nodeid");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+const serverStatusStateNodeId = (0, node_opcua_nodeid_1.coerceNodeId)(node_opcua_constants_1.VariableIds.Server_ServerStatus_State);
+const debugLog = (0, node_opcua_debug_1.make_debugLog)(__filename);
+const doDebug = (0, node_opcua_debug_1.checkDebugFlag)(__filename);
+const warningLog = (0, node_opcua_debug_1.make_warningLog)(__filename);
+class ClientSessionKeepAliveManager extends events_1.EventEmitter {
+    constructor(session) {
+        super();
+        this.transactionInProgress = false;
+        this.count = 0;
+        this.session = session;
+        this.timerId = undefined;
+        this.pingTimeout = 0;
+        this.checkInterval = 0;
+        this.count = 0;
+    }
+    start() {
+        (0, node_opcua_assert_1.assert)(!this.timerId);
+        /* istanbul ignore next*/
+        if (this.session.timeout < 600) {
+            warningLog(`[NODE-OPCUA-W13] ClientSessionKeepAliveManager detected that the session timeout (${this.session.timeout} ms) is really too small: please adjust it to a greater value ( at least 1000))`);
+        }
+        /* istanbul ignore next*/
+        if (this.session.timeout < 100) {
+            throw new Error(`ClientSessionKeepAliveManager detected that the session timeout (${this.session.timeout} ms) is really too small: please adjust it to a greater value ( at least 1000))`);
+        }
+        this.pingTimeout = Math.min(this.session.timeout / 3, 20000);
+        this.checkInterval = Math.max(50, Math.min((this.session.timeout * 2) / 3, 20000));
+        // make sure first one is almost immediate
+        this.timerId = setTimeout(() => this.ping_server(), this.pingTimeout);
+    }
+    stop() {
+        if (this.timerId) {
+            debugLog("ClientSessionKeepAliveManager#stop");
+            clearTimeout(this.timerId);
+            this.timerId = undefined;
+        }
+        else {
+            debugLog("warning ClientSessionKeepAliveManager#stop ignore (already stopped)");
+        }
+    }
+    ping_server() {
+        this._ping_server().then((delta) => {
+            if (!this.session || this.session.hasBeenClosed()) {
+                return; // stop here
+            }
+            if (this.timerId) {
+                const timeout = Math.max(1, this.checkInterval - delta);
+                this.timerId = setTimeout(() => this.ping_server(), timeout);
+            }
+        });
+    }
+    /**
+     * @method ping_server
+     * @internal
+     * when a session is opened on a server, the client shall send request on a regular basis otherwise the server
+     * session object might time out.
+     * start_ping make sure that ping_server is called on a regular basis to prevent session to timeout.
+     *
+     * @param callback
+     */
+    _ping_server() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const session = this.session;
+            if (!session || session.isReconnecting) {
+                debugLog("ClientSessionKeepAliveManager#ping_server => no session available");
+                return 0;
+            }
+            if (!this.timerId) {
+                return 0; // keep-alive has been canceled ....
+            }
+            const now = Date.now(); // getCurrentClock().timestamp.getTime();
+            const timeSinceLastServerContact = now - session.lastResponseReceivedTime.getTime();
+            if (timeSinceLastServerContact < this.pingTimeout) {
+                debugLog("ClientSessionKeepAliveManager#ping_server skipped because last communication with server was not that long ago ping timeout=", Math.round(this.pingTimeout), "timeSinceLastServerContact  = ", timeSinceLastServerContact);
+                // no need to send a ping yet
+                // console.log("Skipping ",timeSinceLastServerContact,this.session.timeout);
+                return timeSinceLastServerContact - this.pingTimeout;
+            }
+            if (session.isReconnecting) {
+                debugLog("ClientSessionKeepAliveManager#ping_server skipped because client is reconnecting");
+                return 0;
+            }
+            if (session.hasBeenClosed()) {
+                debugLog("ClientSessionKeepAliveManager#ping_server skipped because client is reconnecting");
+                return 0;
+            }
+            debugLog("ClientSessionKeepAliveManager#ping_server timeSinceLastServerContact=", timeSinceLastServerContact, "timeout", this.session.timeout);
+            if (this.transactionInProgress) {
+                // readVariable already taking place ! Ignore
+                return 0;
+            }
+            this.transactionInProgress = true;
+            // Server_ServerStatus_State
+            return new Promise((resolve) => {
+                session.readVariableValue(serverStatusStateNodeId, (err, dataValue) => {
+                    this.transactionInProgress = false;
+                    if (err || !dataValue || !dataValue.value) {
+                        if (err) {
+                            warningLog(chalk.cyan(" warning : ClientSessionKeepAliveManager#ping_server "), chalk.yellow(err.message));
+                        }
+                        /**
+                         * @event failure
+                         * raised when the server is not responding or is responding with en error to
+                         * the keep alive read Variable value transaction
+                         */
+                        this.emit("failure");
+                        resolve(0);
+                        return;
+                    }
+                    if (dataValue.statusCode === node_opcua_status_code_1.StatusCodes.Good) {
+                        const newState = dataValue.value.value;
+                        // istanbul ignore next
+                        if (newState !== this.lastKnownState && this.lastKnownState) {
+                            warningLog("ClientSessionKeepAliveManager#Server state has changed = ", node_opcua_common_1.ServerState[newState], " was ", node_opcua_common_1.ServerState[this.lastKnownState]);
+                        }
+                        this.lastKnownState = newState;
+                        this.count++; // increase successful counter
+                    }
+                    debugLog("emit keepalive");
+                    this.emit("keepalive", this.lastKnownState, this.count);
+                    resolve(0);
+                });
+            });
+        });
+    }
+}
+exports.ClientSessionKeepAliveManager = ClientSessionKeepAliveManager;
 //# sourceMappingURL=client_session_keepalive_manager.js.map