node-opcua-server 2.73.1 → 2.76.0

package/dist/i_server_side_publish_engine.js

@@ -1,50 +1,50 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TransferredSubscription = void 0;
-const node_opcua_types_1 = require("node-opcua-types");
-const node_opcua_assert_1 = require("node-opcua-assert");
-class TransferredSubscription {
-    constructor(options) {
-        this.id = options.id;
-        this._sequence_number_generator = options.generator;
-        this.publishEngine = options.publishEngine;
-    }
-    get hasPendingNotifications() {
-        return !!this._pending_notification;
-    }
-    dispose() {
-        this._pending_notification = undefined;
-        this.publishEngine = null;
-    }
-    _publish_pending_notifications() {
-        (0, node_opcua_assert_1.default)(this._pending_notification);
-        const notificationMessage = this._pending_notification;
-        this._pending_notification = undefined;
-        const moreNotifications = false;
-        const subscriptionId = this.id;
-        const response = new node_opcua_types_1.PublishResponse({
-            moreNotifications,
-            notificationMessage: {
-                notificationData: [notificationMessage],
-                publishTime: new Date(),
-                sequenceNumber: 0xffffffff
-            },
-            subscriptionId
-        });
-        // apply sequence number and store in sent_notifications queue
-        (0, node_opcua_assert_1.default)(response.notificationMessage.sequenceNumber === 0xffffffff);
-        response.notificationMessage.sequenceNumber = this._get_next_sequence_number();
-        // xxx    this._sent_notifications.push(response.notificationMessage);
-        // get available sequence number;
-        const availableSequenceNumbers = [response.notificationMessage.sequenceNumber];
-        (0, node_opcua_assert_1.default)(!response.notificationMessage ||
-            availableSequenceNumbers[availableSequenceNumbers.length - 1] === response.notificationMessage.sequenceNumber);
-        response.availableSequenceNumbers = availableSequenceNumbers;
-        this.publishEngine._send_response(this, response);
-    }
-    _get_next_sequence_number() {
-        return this._sequence_number_generator ? this._sequence_number_generator.next() : 0;
-    }
-}
-exports.TransferredSubscription = TransferredSubscription;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TransferredSubscription = void 0;
+const node_opcua_types_1 = require("node-opcua-types");
+const node_opcua_assert_1 = require("node-opcua-assert");
+class TransferredSubscription {
+    constructor(options) {
+        this.id = options.id;
+        this._sequence_number_generator = options.generator;
+        this.publishEngine = options.publishEngine;
+    }
+    get hasPendingNotifications() {
+        return !!this._pending_notification;
+    }
+    dispose() {
+        this._pending_notification = undefined;
+        this.publishEngine = null;
+    }
+    _publish_pending_notifications() {
+        (0, node_opcua_assert_1.default)(this._pending_notification);
+        const notificationMessage = this._pending_notification;
+        this._pending_notification = undefined;
+        const moreNotifications = false;
+        const subscriptionId = this.id;
+        const response = new node_opcua_types_1.PublishResponse({
+            moreNotifications,
+            notificationMessage: {
+                notificationData: [notificationMessage],
+                publishTime: new Date(),
+                sequenceNumber: 0xffffffff
+            },
+            subscriptionId
+        });
+        // apply sequence number and store in sent_notifications queue
+        (0, node_opcua_assert_1.default)(response.notificationMessage.sequenceNumber === 0xffffffff);
+        response.notificationMessage.sequenceNumber = this._get_next_sequence_number();
+        // xxx    this._sent_notifications.push(response.notificationMessage);
+        // get available sequence number;
+        const availableSequenceNumbers = [response.notificationMessage.sequenceNumber];
+        (0, node_opcua_assert_1.default)(!response.notificationMessage ||
+            availableSequenceNumbers[availableSequenceNumbers.length - 1] === response.notificationMessage.sequenceNumber);
+        response.availableSequenceNumbers = availableSequenceNumbers;
+        this.publishEngine._send_response(this, response);
+    }
+    _get_next_sequence_number() {
+        return this._sequence_number_generator ? this._sequence_number_generator.next() : 0;
+    }
+}
+exports.TransferredSubscription = TransferredSubscription;
 //# sourceMappingURL=i_server_side_publish_engine.js.map

package/dist/i_socket_data.d.ts

@@ -1,11 +1,11 @@
-export interface ISocketData {
-    bytesRead: number;
-    bytesWritten: number;
-    localAddress?: string;
-    localPort?: number;
-    remoteAddress?: string;
-    remoteFamily?: string;
-    remotePort?: number;
-    timestamp: Date;
-    reason: string;
-}
+export interface ISocketData {
+    bytesRead: number;
+    bytesWritten: number;
+    localAddress?: string;
+    localPort?: number;
+    remoteAddress?: string;
+    remoteFamily?: string;
+    remotePort?: number;
+    timestamp: Date;
+    reason: string;
+}

package/dist/i_socket_data.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=i_socket_data.js.map

package/dist/index.d.ts

@@ -1,16 +1,16 @@
-/**
- * @module node-opcua-server
- */
-export * from "./base_server";
-export * from "./server_end_point";
-export * from "./register_server_manager";
-export * from "./register_server_manager_mdns_only";
-export * from "./server_publish_engine";
-export * from "./server_subscription";
-export * from "./server_session";
-export * from "./server_capabilities";
-export * from "./server_engine";
-export * from "./opcua_server";
-export * from "./monitored_item";
-export * from "./user_manager";
-export * from "./helper";
+/**
+ * @module node-opcua-server
+ */
+export * from "./base_server";
+export * from "./server_end_point";
+export * from "./register_server_manager";
+export * from "./register_server_manager_mdns_only";
+export * from "./server_publish_engine";
+export * from "./server_subscription";
+export * from "./server_session";
+export * from "./server_capabilities";
+export * from "./server_engine";
+export * from "./opcua_server";
+export * from "./monitored_item";
+export * from "./user_manager";
+export * from "./helper";

package/dist/index.js

@@ -1,33 +1,33 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * @module node-opcua-server
- */
-__exportStar(require("./base_server"), exports);
-__exportStar(require("./server_end_point"), exports);
-__exportStar(require("./register_server_manager"), exports);
-__exportStar(require("./register_server_manager_mdns_only"), exports);
-__exportStar(require("./server_publish_engine"), exports);
-__exportStar(require("./server_subscription"), exports);
-__exportStar(require("./server_session"), exports);
-__exportStar(require("./server_capabilities"), exports);
-__exportStar(require("./server_engine"), exports);
-__exportStar(require("./opcua_server"), exports);
-__exportStar(require("./monitored_item"), exports);
-__exportStar(require("./user_manager"), exports);
-__exportStar(require("./helper"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * @module node-opcua-server
+ */
+__exportStar(require("./base_server"), exports);
+__exportStar(require("./server_end_point"), exports);
+__exportStar(require("./register_server_manager"), exports);
+__exportStar(require("./register_server_manager_mdns_only"), exports);
+__exportStar(require("./server_publish_engine"), exports);
+__exportStar(require("./server_subscription"), exports);
+__exportStar(require("./server_session"), exports);
+__exportStar(require("./server_capabilities"), exports);
+__exportStar(require("./server_engine"), exports);
+__exportStar(require("./opcua_server"), exports);
+__exportStar(require("./monitored_item"), exports);
+__exportStar(require("./user_manager"), exports);
+__exportStar(require("./helper"), exports);
 //# sourceMappingURL=index.js.map

package/dist/monitored_item.d.ts

@@ -1,177 +1,177 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/**
- * @module node-opcua-server
- */
-import { EventEmitter } from "events";
-import { BaseNode, SessionContext } from "node-opcua-address-space";
-import { UInt32 } from "node-opcua-basic-types";
-import { NodeClass, QualifiedNameOptions } from "node-opcua-data-model";
-import { AttributeIds } from "node-opcua-data-model";
-import { DataValue } from "node-opcua-data-value";
-import { ExtensionObject } from "node-opcua-extension-object";
-import { NodeId } from "node-opcua-nodeid";
-import { NumericRange } from "node-opcua-numeric-range";
-import { ObjectRegistry } from "node-opcua-object-registry";
-import { TimestampsToReturn } from "node-opcua-service-read";
-import { MonitoredItemModifyResult, MonitoredItemNotification, MonitoringMode, MonitoringParameters } from "node-opcua-service-subscription";
-import { StatusCode } from "node-opcua-status-code";
-import { EventFieldList, MonitoringFilter, ReadValueIdOptions, SubscriptionDiagnosticsDataType } from "node-opcua-types";
-export declare type QueueItem = MonitoredItemNotification | EventFieldList;
-export interface MonitoredItemOptions extends MonitoringParameters {
-    monitoringMode: MonitoringMode;
-    /**
-     * the monitoredItem Id assigned by the server to this monitoredItem.
-     */
-    monitoredItemId: number;
-    itemToMonitor?: ReadValueIdOptions;
-    timestampsToReturn?: TimestampsToReturn;
-    filter: ExtensionObject | null;
-    /**
-     * if discardOldest === true, older items are removed from the queue when queue overflows
-     */
-    discardOldest: boolean;
-    /**
-     * the size of the queue.
-     */
-    queueSize: number;
-    /**
-     * the monitored item sampling interval ..
-     */
-    samplingInterval: number;
-    /**
-     * the client handle
-     */
-    clientHandle: number;
-}
-export interface BaseNode2 extends EventEmitter {
-    nodeId: NodeId;
-    browseName: QualifiedNameOptions;
-    nodeClass: NodeClass;
-    dataType: NodeId;
-    addressSpace: any;
-    readAttribute(context: SessionContext | null, attributeId: AttributeIds): DataValue;
-}
-declare type TimerKey = NodeJS.Timer;
-export interface ISubscription {
-    $session?: any;
-    subscriptionDiagnostics: SubscriptionDiagnosticsDataType;
-    getMonitoredItem(monitoredItemId: number): MonitoredItem | null;
-}
-/**
- * a server side monitored item
- *
- * - Once created, the MonitoredItem will raised an "samplingEvent" event every "samplingInterval" millisecond
- *   until {{#crossLink "MonitoredItem/terminate:method"}}{{/crossLink}} is called.
- *
- * - It is up to the  event receiver to call {{#crossLink "MonitoredItem/recordValue:method"}}{{/crossLink}}.
- *
- */
-export declare class MonitoredItem extends EventEmitter {
-    get node(): BaseNode | null;
-    set node(someNode: BaseNode | null);
-    static registry: ObjectRegistry;
-    static minimumSamplingInterval: number;
-    static defaultSamplingInterval: number;
-    static maximumSamplingInterval: number;
-    samplingInterval: number;
-    monitoredItemId: number;
-    overflow: boolean;
-    oldDataValue?: DataValue;
-    monitoringMode: MonitoringMode;
-    timestampsToReturn: TimestampsToReturn;
-    itemToMonitor: any;
-    filter: MonitoringFilter | null;
-    discardOldest: boolean;
-    queueSize: number;
-    clientHandle: UInt32;
-    $subscription?: ISubscription;
-    _samplingId?: TimerKey | string;
-    samplingFunc: ((this: MonitoredItem, value: DataValue, callback: (err: Error | null, dataValue?: DataValue) => void) => void) | null;
-    private _node;
-    private queue;
-    private _semantic_version;
-    private _is_sampling;
-    private _on_opcua_event_received_callback;
-    private _attribute_changed_callback;
-    private _value_changed_callback;
-    private _semantic_changed_callback;
-    private _on_node_disposed_listener;
-    private _linkedItems?;
-    private _triggeredNotifications?;
-    constructor(options: MonitoredItemOptions);
-    setNode(node: BaseNode): void;
-    setMonitoringMode(monitoringMode: MonitoringMode): void;
-    /**
-     * Terminate the  MonitoredItem.
-     * @method terminate
-     *
-     * This will stop the internal sampling timer.
-     */
-    terminate(): void;
-    dispose(): void;
-    get isSampling(): boolean;
-    toString(): string;
-    /**
-     * @param dataValue       the whole dataValue
-     * @param skipChangeTest  indicates whether recordValue should  not check that dataValue is really
-     *                                  different from previous one, ( by checking timestamps but also variant value)
-     * @private
-     *
-     * Notes:
-     *  - recordValue can only be called within timer event
-     *  - for performance reason, dataValue may be a shared value with the underlying node,
-     *    therefore recordValue must clone the dataValue to make sure it retains a snapshot
-     *    of the contain at the time recordValue was called.
-     *
-     */
-    recordValue(dataValue: DataValue, skipChangeTest: boolean, indexRange?: NumericRange): void;
-    hasLinkItem(linkedMonitoredItemId: number): boolean;
-    addLinkItem(linkedMonitoredItemId: number): StatusCode;
-    removeLinkItem(linkedMonitoredItemId: number): StatusCode;
-    /**
-     * @internals
-     */
-    private triggerLinkedItems;
-    get hasMonitoredItemNotifications(): boolean;
-    /**
-     * @internals
-     */
-    private trigger;
-    extractMonitoredItemNotifications(bForce?: boolean): QueueItem[];
-    modify(timestampsToReturn: TimestampsToReturn, monitoringParameters: MonitoringParameters): MonitoredItemModifyResult;
-    resendInitialValues(): Promise<void>;
-    /**
-     * @method _on_sampling_timer
-     * @private
-     * request
-     *
-     */
-    private _on_sampling_timer;
-    private _stop_sampling;
-    private _on_value_changed;
-    private _on_semantic_changed;
-    private _on_opcua_event;
-    private _getSession;
-    private _start_sampling;
-    private __start_sampling;
-    private _set_parameters;
-    private _setOverflowBit;
-    private _enqueue_notification;
-    private _makeDataChangeNotification;
-    /**
-     * @method _enqueue_value
-     * @param dataValue {DataValue} the dataValue to enqueue
-     * @private
-     */
-    private _enqueue_value;
-    private _makeEventFieldList;
-    private _enqueue_event;
-    private _empty_queue;
-    private _clear_timer;
-    private _set_timer;
-    private _adjust_queue_to_match_new_queue_size;
-    private _adjust_sampling;
-    private _on_node_disposed;
-}
-export {};
+/// <reference types="node" />
+/// <reference types="node" />
+/**
+ * @module node-opcua-server
+ */
+import { EventEmitter } from "events";
+import { BaseNode, SessionContext } from "node-opcua-address-space";
+import { UInt32 } from "node-opcua-basic-types";
+import { NodeClass, QualifiedNameOptions } from "node-opcua-data-model";
+import { AttributeIds } from "node-opcua-data-model";
+import { DataValue } from "node-opcua-data-value";
+import { ExtensionObject } from "node-opcua-extension-object";
+import { NodeId } from "node-opcua-nodeid";
+import { NumericRange } from "node-opcua-numeric-range";
+import { ObjectRegistry } from "node-opcua-object-registry";
+import { TimestampsToReturn } from "node-opcua-service-read";
+import { MonitoredItemModifyResult, MonitoredItemNotification, MonitoringMode, MonitoringParameters } from "node-opcua-service-subscription";
+import { StatusCode } from "node-opcua-status-code";
+import { EventFieldList, MonitoringFilter, ReadValueIdOptions, SubscriptionDiagnosticsDataType } from "node-opcua-types";
+export declare type QueueItem = MonitoredItemNotification | EventFieldList;
+export interface MonitoredItemOptions extends MonitoringParameters {
+    monitoringMode: MonitoringMode;
+    /**
+     * the monitoredItem Id assigned by the server to this monitoredItem.
+     */
+    monitoredItemId: number;
+    itemToMonitor?: ReadValueIdOptions;
+    timestampsToReturn?: TimestampsToReturn;
+    filter: ExtensionObject | null;
+    /**
+     * if discardOldest === true, older items are removed from the queue when queue overflows
+     */
+    discardOldest: boolean;
+    /**
+     * the size of the queue.
+     */
+    queueSize: number;
+    /**
+     * the monitored item sampling interval ..
+     */
+    samplingInterval: number;
+    /**
+     * the client handle
+     */
+    clientHandle: number;
+}
+export interface BaseNode2 extends EventEmitter {
+    nodeId: NodeId;
+    browseName: QualifiedNameOptions;
+    nodeClass: NodeClass;
+    dataType: NodeId;
+    addressSpace: any;
+    readAttribute(context: SessionContext | null, attributeId: AttributeIds): DataValue;
+}
+declare type TimerKey = NodeJS.Timer;
+export interface ISubscription {
+    $session?: any;
+    subscriptionDiagnostics: SubscriptionDiagnosticsDataType;
+    getMonitoredItem(monitoredItemId: number): MonitoredItem | null;
+}
+/**
+ * a server side monitored item
+ *
+ * - Once created, the MonitoredItem will raised an "samplingEvent" event every "samplingInterval" millisecond
+ *   until {{#crossLink "MonitoredItem/terminate:method"}}{{/crossLink}} is called.
+ *
+ * - It is up to the  event receiver to call {{#crossLink "MonitoredItem/recordValue:method"}}{{/crossLink}}.
+ *
+ */
+export declare class MonitoredItem extends EventEmitter {
+    get node(): BaseNode | null;
+    set node(someNode: BaseNode | null);
+    static registry: ObjectRegistry;
+    static minimumSamplingInterval: number;
+    static defaultSamplingInterval: number;
+    static maximumSamplingInterval: number;
+    samplingInterval: number;
+    monitoredItemId: number;
+    overflow: boolean;
+    oldDataValue?: DataValue;
+    monitoringMode: MonitoringMode;
+    timestampsToReturn: TimestampsToReturn;
+    itemToMonitor: any;
+    filter: MonitoringFilter | null;
+    discardOldest: boolean;
+    queueSize: number;
+    clientHandle: UInt32;
+    $subscription?: ISubscription;
+    _samplingId?: TimerKey | string;
+    samplingFunc: ((this: MonitoredItem, value: DataValue, callback: (err: Error | null, dataValue?: DataValue) => void) => void) | null;
+    private _node;
+    private queue;
+    private _semantic_version;
+    private _is_sampling;
+    private _on_opcua_event_received_callback;
+    private _attribute_changed_callback;
+    private _value_changed_callback;
+    private _semantic_changed_callback;
+    private _on_node_disposed_listener;
+    private _linkedItems?;
+    private _triggeredNotifications?;
+    constructor(options: MonitoredItemOptions);
+    setNode(node: BaseNode): void;
+    setMonitoringMode(monitoringMode: MonitoringMode): void;
+    /**
+     * Terminate the  MonitoredItem.
+     * @method terminate
+     *
+     * This will stop the internal sampling timer.
+     */
+    terminate(): void;
+    dispose(): void;
+    get isSampling(): boolean;
+    toString(): string;
+    /**
+     * @param dataValue       the whole dataValue
+     * @param skipChangeTest  indicates whether recordValue should  not check that dataValue is really
+     *                                  different from previous one, ( by checking timestamps but also variant value)
+     * @private
+     *
+     * Notes:
+     *  - recordValue can only be called within timer event
+     *  - for performance reason, dataValue may be a shared value with the underlying node,
+     *    therefore recordValue must clone the dataValue to make sure it retains a snapshot
+     *    of the contain at the time recordValue was called.
+     *
+     */
+    recordValue(dataValue: DataValue, skipChangeTest: boolean, indexRange?: NumericRange): void;
+    hasLinkItem(linkedMonitoredItemId: number): boolean;
+    addLinkItem(linkedMonitoredItemId: number): StatusCode;
+    removeLinkItem(linkedMonitoredItemId: number): StatusCode;
+    /**
+     * @internals
+     */
+    private triggerLinkedItems;
+    get hasMonitoredItemNotifications(): boolean;
+    /**
+     * @internals
+     */
+    private trigger;
+    extractMonitoredItemNotifications(bForce?: boolean): QueueItem[];
+    modify(timestampsToReturn: TimestampsToReturn, monitoringParameters: MonitoringParameters): MonitoredItemModifyResult;
+    resendInitialValues(): Promise<void>;
+    /**
+     * @method _on_sampling_timer
+     * @private
+     * request
+     *
+     */
+    private _on_sampling_timer;
+    private _stop_sampling;
+    private _on_value_changed;
+    private _on_semantic_changed;
+    private _on_opcua_event;
+    private _getSession;
+    private _start_sampling;
+    private __start_sampling;
+    private _set_parameters;
+    private _setOverflowBit;
+    private _enqueue_notification;
+    private _makeDataChangeNotification;
+    /**
+     * @method _enqueue_value
+     * @param dataValue {DataValue} the dataValue to enqueue
+     * @private
+     */
+    private _enqueue_value;
+    private _makeEventFieldList;
+    private _enqueue_event;
+    private _empty_queue;
+    private _clear_timer;
+    private _set_timer;
+    private _adjust_queue_to_match_new_queue_size;
+    private _adjust_sampling;
+    private _on_node_disposed;
+}
+export {};