node-opcua-server 2.76.0 → 2.77.0

package/dist/server_publish_engine.d.ts

@@ -1,113 +1,113 @@
-/// <reference types="node" />
-/**
- * @module node-opcua-server
- */
-import { EventEmitter } from "events";
-import { ObjectRegistry } from "node-opcua-object-registry";
-import { StatusCode } from "node-opcua-status-code";
-import { PublishRequest, PublishResponse, ServiceFault, SubscriptionAcknowledgement } from "node-opcua-types";
-import { Subscription } from "./server_subscription";
-import { IServerSidePublishEngine, IClosedOrTransferredSubscription } from "./i_server_side_publish_engine";
-export interface ServerSidePublishEngineOptions {
-    maxPublishRequestInQueue?: number;
-}
-interface PublishData {
-    request: PublishRequest;
-    serverTimeWhenReceived: number;
-    results: StatusCode[];
-    callback: (request: PublishRequest, response: PublishResponse | ServiceFault) => void;
-}
-/***
- *  a Publish Engine for a given session
- */
-export declare class ServerSidePublishEngine extends EventEmitter implements IServerSidePublishEngine {
-    static registry: ObjectRegistry;
-    /**
-     * @private
-     */
-    static transferSubscriptionsToOrphan(srcPublishEngine: ServerSidePublishEngine, destPublishEngine: ServerSidePublishEngine): void;
-    /**
-     * @param subscription
-     * @param destPublishEngine
-     * @param sendInitialValues true if initial values should be sent
-     * @private
-     */
-    static transferSubscription(subscription: Subscription, destPublishEngine: ServerSidePublishEngine, sendInitialValues: boolean): Promise<Subscription>;
-    maxPublishRequestInQueue: number;
-    isSessionClosed: boolean;
-    private _publish_request_queue;
-    private _subscriptions;
-    private _closed_subscriptions;
-    constructor(options?: ServerSidePublishEngineOptions);
-    toString(): string;
-    dispose(): void;
-    process_subscriptionAcknowledgements(subscriptionAcknowledgements: SubscriptionAcknowledgement[]): StatusCode[];
-    /**
-     * get a array of subscription handled by the publish engine.
-     */
-    get subscriptions(): Subscription[];
-    /**
-     */
-    add_subscription(subscription: Subscription): Subscription;
-    detach_subscription(subscription: Subscription): Subscription;
-    /**
-     */
-    shutdown(): void;
-    /**
-     * number of pending PublishRequest available in queue
-     */
-    get pendingPublishRequestCount(): number;
-    /**
-     * number of subscriptions
-     */
-    get subscriptionCount(): number;
-    get pendingClosedSubscriptionCount(): number;
-    get currentMonitoredItemCount(): number;
-    _purge_dangling_subscription(subscriptionId: number): void;
-    on_close_subscription(subscription: IClosedOrTransferredSubscription): void;
-    /**
-     * retrieve a subscription by id.
-     * @param subscriptionId
-     * @return Subscription
-     */
-    getSubscriptionById(subscriptionId: number | string): Subscription;
-    findLateSubscriptions(): Subscription[];
-    get hasLateSubscriptions(): boolean;
-    findLateSubscriptionsSortedByAge(): Subscription[];
-    cancelPendingPublishRequestBeforeChannelChange(): void;
-    onSessionClose(): void;
-    /**
-     * @private
-     */
-    cancelPendingPublishRequest(): void;
-    /**
-     *
-     * @param request
-     * @param callback
-     * @private
-     * @internal
-     */
-    _on_PublishRequest(request: PublishRequest, callback?: (request1: PublishRequest, response: PublishResponse | ServiceFault) => void): void;
-    private _find_starving_subscription;
-    private _feed_late_subscription;
-    private _feed_closed_subscription;
-    private _send_error_for_request;
-    private _cancelPendingPublishRequest;
-    private _handle_too_many_requests;
-    /**
-     * call by a subscription when no notification message is available after the keep alive delay has
-     * expired.
-     *
-     * @method send_keep_alive_response
-     * @param subscriptionId
-     * @param future_sequence_number
-     * @return true if a publish response has been sent
-     */
-    send_keep_alive_response(subscriptionId: number, future_sequence_number: number): boolean;
-    _send_response(subscription: Subscription, response: PublishResponse): void;
-    _on_tick(): void;
-    private _cancelTimeoutRequests;
-    _send_response_for_request(publishData: PublishData, response: PublishResponse | ServiceFault): void;
-    _send_valid_response_for_request(publishData: PublishData, response: PublishResponse): void;
-}
-export {};
+/// <reference types="node" />
+/**
+ * @module node-opcua-server
+ */
+import { EventEmitter } from "events";
+import { ObjectRegistry } from "node-opcua-object-registry";
+import { StatusCode } from "node-opcua-status-code";
+import { PublishRequest, PublishResponse, ServiceFault, SubscriptionAcknowledgement } from "node-opcua-types";
+import { Subscription } from "./server_subscription";
+import { IServerSidePublishEngine, IClosedOrTransferredSubscription } from "./i_server_side_publish_engine";
+export interface ServerSidePublishEngineOptions {
+    maxPublishRequestInQueue?: number;
+}
+interface PublishData {
+    request: PublishRequest;
+    serverTimeWhenReceived: number;
+    results: StatusCode[];
+    callback: (request: PublishRequest, response: PublishResponse | ServiceFault) => void;
+}
+/***
+ *  a Publish Engine for a given session
+ */
+export declare class ServerSidePublishEngine extends EventEmitter implements IServerSidePublishEngine {
+    static registry: ObjectRegistry;
+    /**
+     * @private
+     */
+    static transferSubscriptionsToOrphan(srcPublishEngine: ServerSidePublishEngine, destPublishEngine: ServerSidePublishEngine): void;
+    /**
+     * @param subscription
+     * @param destPublishEngine
+     * @param sendInitialValues true if initial values should be sent
+     * @private
+     */
+    static transferSubscription(subscription: Subscription, destPublishEngine: ServerSidePublishEngine, sendInitialValues: boolean): Promise<Subscription>;
+    maxPublishRequestInQueue: number;
+    isSessionClosed: boolean;
+    private _publish_request_queue;
+    private _subscriptions;
+    private _closed_subscriptions;
+    constructor(options?: ServerSidePublishEngineOptions);
+    toString(): string;
+    dispose(): void;
+    process_subscriptionAcknowledgements(subscriptionAcknowledgements: SubscriptionAcknowledgement[]): StatusCode[];
+    /**
+     * get a array of subscription handled by the publish engine.
+     */
+    get subscriptions(): Subscription[];
+    /**
+     */
+    add_subscription(subscription: Subscription): Subscription;
+    detach_subscription(subscription: Subscription): Subscription;
+    /**
+     */
+    shutdown(): void;
+    /**
+     * number of pending PublishRequest available in queue
+     */
+    get pendingPublishRequestCount(): number;
+    /**
+     * number of subscriptions
+     */
+    get subscriptionCount(): number;
+    get pendingClosedSubscriptionCount(): number;
+    get currentMonitoredItemCount(): number;
+    _purge_dangling_subscription(subscriptionId: number): void;
+    on_close_subscription(subscription: IClosedOrTransferredSubscription): void;
+    /**
+     * retrieve a subscription by id.
+     * @param subscriptionId
+     * @return Subscription
+     */
+    getSubscriptionById(subscriptionId: number | string): Subscription;
+    findLateSubscriptions(): Subscription[];
+    get hasLateSubscriptions(): boolean;
+    findLateSubscriptionsSortedByAge(): Subscription[];
+    cancelPendingPublishRequestBeforeChannelChange(): void;
+    onSessionClose(): void;
+    /**
+     * @private
+     */
+    cancelPendingPublishRequest(): void;
+    /**
+     *
+     * @param request
+     * @param callback
+     * @private
+     * @internal
+     */
+    _on_PublishRequest(request: PublishRequest, callback?: (request1: PublishRequest, response: PublishResponse | ServiceFault) => void): void;
+    private _find_starving_subscription;
+    private _feed_late_subscription;
+    private _feed_closed_subscription;
+    private _send_error_for_request;
+    private _cancelPendingPublishRequest;
+    private _handle_too_many_requests;
+    /**
+     * call by a subscription when no notification message is available after the keep alive delay has
+     * expired.
+     *
+     * @method send_keep_alive_response
+     * @param subscriptionId
+     * @param future_sequence_number
+     * @return true if a publish response has been sent
+     */
+    send_keep_alive_response(subscriptionId: number, future_sequence_number: number): boolean;
+    _send_response(subscription: Subscription, response: PublishResponse): void;
+    _on_tick(): void;
+    private _cancelTimeoutRequests;
+    _send_response_for_request(publishData: PublishData, response: PublishResponse | ServiceFault): void;
+    _send_valid_response_for_request(publishData: PublishData, response: PublishResponse): void;
+}
+export {};