node-opcua-server 2.73.1 → 2.76.0

package/dist/register_server_manager.d.ts

@@ -1,96 +1,96 @@
-/// <reference types="node" />
-/// <reference types="node" />
-/**
- * @module node-opcua-server
- */
-import { EventEmitter } from "events";
-import { ErrorCallback, UAString } from "node-opcua-basic-types";
-import { LocalizedTextOptions } from "node-opcua-client";
-import { ApplicationType } from "node-opcua-types";
-import { OPCUACertificateManager } from "node-opcua-certificate-manager";
-import { IRegisterServerManager } from "./i_register_server_manager";
-export declare enum RegisterServerManagerStatus {
-    INACTIVE = 1,
-    INITIALIZING = 2,
-    REGISTERING = 3,
-    WAITING = 4,
-    UNREGISTERING = 5
-}
-export interface IPartialServer {
-    serverCertificateManager: OPCUACertificateManager;
-    certificateFile: string;
-    privateKeyFile: string;
-    serverType: ApplicationType;
-    serverInfo: {
-        applicationUri: UAString;
-        applicationName: LocalizedTextOptions;
-        productUri: UAString;
-    };
-    capabilitiesForMDNS: string[];
-    getDiscoveryUrls(): string[];
-    getCertificate(): Buffer;
-}
-export interface RegisterServerManagerOptions {
-    server: IPartialServer;
-    discoveryServerEndpointUrl: string;
-}
-/**
- * RegisterServerManager is responsible to Register an opcua server on a LDS or LDS-ME server
- * This class takes in charge :
- *  - the initial registration of a server
- *  - the regular registration renewal (every 8 minutes or so ...)
- *  - dealing with cases where LDS is not up and running when server starts.
- *    ( in this case the connection will be continuously attempted using the infinite
- *    back-off strategy
- *  - the un-registration of the server ( during shutdown for instance)
- *
- * Events:
- *
- * Emitted when the server is trying to registered the LDS
- * but when the connection to the lds has failed
- * serverRegistrationPending is sent when the backoff signal of the
- * connection process is rained
- * @event serverRegistrationPending
- *
- * emitted when the server is successfully registered to the LDS
- * @event serverRegistered
- *
- * emitted when the server has successfully renewed its registration to the LDS
- * @event serverRegistrationRenewed
- *
- * emitted when the server is successfully unregistered to the LDS
- * ( for instance during shutdown)
- * @event serverUnregistered
- *
- *
- * (LDS => Local Discovery Server)
- * @param options
- * @param options.server {OPCUAServer}
- * @param options.discoveryServerEndpointUrl {String}
- * @constructor
- */
-export declare class RegisterServerManager extends EventEmitter implements IRegisterServerManager {
-    discoveryServerEndpointUrl: string;
-    timeout: number;
-    private server;
-    private _registrationTimerId;
-    private state;
-    private _registration_client;
-    private selectedEndpoint?;
-    private _serverEndpoints;
-    constructor(options: RegisterServerManagerOptions);
-    dispose(): void;
-    _emitEvent(eventName: string): void;
-    _setState(status: RegisterServerManagerStatus): void;
-    start(callback: ErrorCallback): void;
-    private _establish_initial_connection;
-    _trigger_next(): void;
-    stop(callback: ErrorCallback): void;
-    /**
-     * @param isOnline
-     * @param outer_callback
-     * @private
-     */
-    _registerServer(isOnline: boolean, outer_callback: ErrorCallback): void;
-    private _cancel_pending_client_if_any;
-}
+/// <reference types="node" />
+/// <reference types="node" />
+/**
+ * @module node-opcua-server
+ */
+import { EventEmitter } from "events";
+import { ErrorCallback, UAString } from "node-opcua-basic-types";
+import { LocalizedTextOptions } from "node-opcua-client";
+import { ApplicationType } from "node-opcua-types";
+import { OPCUACertificateManager } from "node-opcua-certificate-manager";
+import { IRegisterServerManager } from "./i_register_server_manager";
+export declare enum RegisterServerManagerStatus {
+    INACTIVE = 1,
+    INITIALIZING = 2,
+    REGISTERING = 3,
+    WAITING = 4,
+    UNREGISTERING = 5
+}
+export interface IPartialServer {
+    serverCertificateManager: OPCUACertificateManager;
+    certificateFile: string;
+    privateKeyFile: string;
+    serverType: ApplicationType;
+    serverInfo: {
+        applicationUri: UAString;
+        applicationName: LocalizedTextOptions;
+        productUri: UAString;
+    };
+    capabilitiesForMDNS: string[];
+    getDiscoveryUrls(): string[];
+    getCertificate(): Buffer;
+}
+export interface RegisterServerManagerOptions {
+    server: IPartialServer;
+    discoveryServerEndpointUrl: string;
+}
+/**
+ * RegisterServerManager is responsible to Register an opcua server on a LDS or LDS-ME server
+ * This class takes in charge :
+ *  - the initial registration of a server
+ *  - the regular registration renewal (every 8 minutes or so ...)
+ *  - dealing with cases where LDS is not up and running when server starts.
+ *    ( in this case the connection will be continuously attempted using the infinite
+ *    back-off strategy
+ *  - the un-registration of the server ( during shutdown for instance)
+ *
+ * Events:
+ *
+ * Emitted when the server is trying to registered the LDS
+ * but when the connection to the lds has failed
+ * serverRegistrationPending is sent when the backoff signal of the
+ * connection process is rained
+ * @event serverRegistrationPending
+ *
+ * emitted when the server is successfully registered to the LDS
+ * @event serverRegistered
+ *
+ * emitted when the server has successfully renewed its registration to the LDS
+ * @event serverRegistrationRenewed
+ *
+ * emitted when the server is successfully unregistered to the LDS
+ * ( for instance during shutdown)
+ * @event serverUnregistered
+ *
+ *
+ * (LDS => Local Discovery Server)
+ * @param options
+ * @param options.server {OPCUAServer}
+ * @param options.discoveryServerEndpointUrl {String}
+ * @constructor
+ */
+export declare class RegisterServerManager extends EventEmitter implements IRegisterServerManager {
+    discoveryServerEndpointUrl: string;
+    timeout: number;
+    private server;
+    private _registrationTimerId;
+    private state;
+    private _registration_client;
+    private selectedEndpoint?;
+    private _serverEndpoints;
+    constructor(options: RegisterServerManagerOptions);
+    dispose(): void;
+    _emitEvent(eventName: string): void;
+    _setState(status: RegisterServerManagerStatus): void;
+    start(callback: ErrorCallback): void;
+    private _establish_initial_connection;
+    _trigger_next(): void;
+    stop(callback: ErrorCallback): void;
+    /**
+     * @param isOnline
+     * @param outer_callback
+     * @private
+     */
+    _registerServer(isOnline: boolean, outer_callback: ErrorCallback): void;
+    private _cancel_pending_client_if_any;
+}