node-opcua-server 2.70.1 → 2.71.0

package/dist/server_end_point.d.ts

@@ -1,183 +1,183 @@
-/// <reference types="node" />
-/**
- * @module node-opcua-server
- */
-import { EventEmitter } from "events";
-import { OPCUACertificateManager } from "node-opcua-certificate-manager";
-import { Certificate, PrivateKeyPEM } from "node-opcua-crypto";
-import { MessageSecurityMode, SecurityPolicy, ServerSecureChannelLayer, ServerSecureChannelParent } from "node-opcua-secure-channel";
-import { EndpointDescription } from "node-opcua-service-endpoints";
-import { ApplicationDescription } from "node-opcua-service-endpoints";
-export interface OPCUAServerEndPointOptions {
-    /**
-     * the tcp port
-     */
-    port: number;
-    /**
-     * the DER certificate chain
-     */
-    certificateChain: Certificate;
-    /**
-     * privateKey
-     */
-    privateKey: PrivateKeyPEM;
-    certificateManager: OPCUACertificateManager;
-    /**
-     *  the default secureToken lifetime @default=60000
-     */
-    defaultSecureTokenLifetime?: number;
-    /**
-     * the maximum number of connection allowed on the TCP server socket
-     * @default 20
-     */
-    maxConnections?: number;
-    /**
-     *  the  timeout for the TCP HEL/ACK transaction (in ms)
-     *  @default 30000
-     */
-    timeout?: number;
-    serverInfo: ApplicationDescription;
-    objectFactory?: any;
-}
-export interface EndpointDescriptionParams {
-    allowAnonymous?: boolean;
-    restricted?: boolean;
-    allowUnsecurePassword?: boolean;
-    resourcePath?: string;
-    alternateHostname?: string[];
-    hostname: string;
-    securityPolicies: SecurityPolicy[];
-}
-export interface AddStandardEndpointDescriptionsParam {
-    securityModes?: MessageSecurityMode[];
-    securityPolicies?: SecurityPolicy[];
-    disableDiscovery?: boolean;
-    allowAnonymous?: boolean;
-    restricted?: boolean;
-    hostname?: string;
-    alternateHostname?: string[];
-    allowUnsecurePassword?: boolean;
-    resourcePath?: string;
-}
-/**
- * OPCUAServerEndPoint a Server EndPoint.
- * A sever end point is listening to one port
- * note:
- *   see OPCUA Release 1.03 part 4 page 108 7.1 ApplicationDescription
- */
-export declare class OPCUAServerEndPoint extends EventEmitter implements ServerSecureChannelParent {
-    /**
-     * the tcp port
-     */
-    port: number;
-    certificateManager: OPCUACertificateManager;
-    defaultSecureTokenLifetime: number;
-    maxConnections: number;
-    timeout: number;
-    bytesWrittenInOldChannels: number;
-    bytesReadInOldChannels: number;
-    transactionsCountOldChannels: number;
-    securityTokenCountOldChannels: number;
-    serverInfo: ApplicationDescription;
-    objectFactory: any;
-    _on_new_channel?: (channel: ServerSecureChannelLayer) => void;
-    _on_close_channel?: (channel: ServerSecureChannelLayer) => void;
-    _on_connectionRefused?: (socketData: any) => void;
-    _on_openSecureChannelFailure?: (socketData: any, channelData: any) => void;
-    private _certificateChain;
-    private _privateKey;
-    private _channels;
-    private _server?;
-    private _endpoints;
-    private _listen_callback?;
-    private _started;
-    private _counter;
-    private _policy_deduplicator;
-    constructor(options: OPCUAServerEndPointOptions);
-    dispose(): void;
-    toString(): string;
-    getChannels(): ServerSecureChannelLayer[];
-    /**
-     * Returns the X509 DER form of the server certificate
-     */
-    getCertificate(): Certificate;
-    /**
-     * Returns the X509 DER form of the server certificate
-     */
-    getCertificateChain(): Certificate;
-    /**
-     * the private key
-     */
-    getPrivateKey(): PrivateKeyPEM;
-    /**
-     * The number of active channel on this end point.
-     */
-    get currentChannelCount(): number;
-    /**
-     * @method getEndpointDescription
-     * @param securityMode
-     * @param securityPolicy
-     * @return endpoint_description {EndpointDescription|null}
-     */
-    getEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, endpointUrl: string | null): EndpointDescription | null;
-    addEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, options?: EndpointDescriptionParams): void;
-    addRestrictedEndpointDescription(options: EndpointDescriptionParams): void;
-    addStandardEndpointDescriptions(options?: AddStandardEndpointDescriptionsParam): void;
-    /**
-     * returns the list of end point descriptions.
-     */
-    endpointDescriptions(): EndpointDescription[];
-    /**
-     * @method listen
-     * @async
-     */
-    listen(callback: (err?: Error) => void): void;
-    killClientSockets(callback: (err?: Error) => void): void;
-    suspendConnection(callback: (err?: Error) => void): void;
-    restoreConnection(callback: (err?: Error) => void): void;
-    abruptlyInterruptChannels(): void;
-    /**
-     * @method shutdown
-     * @async
-     */
-    shutdown(callback: (err?: Error) => void): void;
-    /**
-     * @method start
-     * @async
-     * @param callback
-     */
-    start(callback: (err?: Error) => void): void;
-    get bytesWritten(): number;
-    get bytesRead(): number;
-    get transactionsCount(): number;
-    get securityTokenCount(): number;
-    get activeChannelCount(): number;
-    private _dump_statistics;
-    private _setup_server;
-    private _on_client_connection;
-    private _preregisterChannel;
-    private _un_pre_registerChannel;
-    /**
-     * @method _registerChannel
-     * @param channel
-     * @private
-     */
-    private _registerChannel;
-    /**
-     * @method _unregisterChannel
-     * @param channel
-     * @private
-     */
-    private _unregisterChannel;
-    private _end_listen;
-    /**
-     *  shutdown_channel
-     * @param channel
-     * @param inner_callback
-     */
-    private shutdown_channel;
-    /**
-     * @private
-     */
-    private _prevent_DDOS_Attack;
-}
+/// <reference types="node" />
+/**
+ * @module node-opcua-server
+ */
+import { EventEmitter } from "events";
+import { OPCUACertificateManager } from "node-opcua-certificate-manager";
+import { Certificate, PrivateKeyPEM } from "node-opcua-crypto";
+import { MessageSecurityMode, SecurityPolicy, ServerSecureChannelLayer, ServerSecureChannelParent } from "node-opcua-secure-channel";
+import { EndpointDescription } from "node-opcua-service-endpoints";
+import { ApplicationDescription } from "node-opcua-service-endpoints";
+export interface OPCUAServerEndPointOptions {
+    /**
+     * the tcp port
+     */
+    port: number;
+    /**
+     * the DER certificate chain
+     */
+    certificateChain: Certificate;
+    /**
+     * privateKey
+     */
+    privateKey: PrivateKeyPEM;
+    certificateManager: OPCUACertificateManager;
+    /**
+     *  the default secureToken lifetime @default=60000
+     */
+    defaultSecureTokenLifetime?: number;
+    /**
+     * the maximum number of connection allowed on the TCP server socket
+     * @default 20
+     */
+    maxConnections?: number;
+    /**
+     *  the  timeout for the TCP HEL/ACK transaction (in ms)
+     *  @default 30000
+     */
+    timeout?: number;
+    serverInfo: ApplicationDescription;
+    objectFactory?: any;
+}
+export interface EndpointDescriptionParams {
+    allowAnonymous?: boolean;
+    restricted?: boolean;
+    allowUnsecurePassword?: boolean;
+    resourcePath?: string;
+    alternateHostname?: string[];
+    hostname: string;
+    securityPolicies: SecurityPolicy[];
+}
+export interface AddStandardEndpointDescriptionsParam {
+    securityModes?: MessageSecurityMode[];
+    securityPolicies?: SecurityPolicy[];
+    disableDiscovery?: boolean;
+    allowAnonymous?: boolean;
+    restricted?: boolean;
+    hostname?: string;
+    alternateHostname?: string[];
+    allowUnsecurePassword?: boolean;
+    resourcePath?: string;
+}
+/**
+ * OPCUAServerEndPoint a Server EndPoint.
+ * A sever end point is listening to one port
+ * note:
+ *   see OPCUA Release 1.03 part 4 page 108 7.1 ApplicationDescription
+ */
+export declare class OPCUAServerEndPoint extends EventEmitter implements ServerSecureChannelParent {
+    /**
+     * the tcp port
+     */
+    port: number;
+    certificateManager: OPCUACertificateManager;
+    defaultSecureTokenLifetime: number;
+    maxConnections: number;
+    timeout: number;
+    bytesWrittenInOldChannels: number;
+    bytesReadInOldChannels: number;
+    transactionsCountOldChannels: number;
+    securityTokenCountOldChannels: number;
+    serverInfo: ApplicationDescription;
+    objectFactory: any;
+    _on_new_channel?: (channel: ServerSecureChannelLayer) => void;
+    _on_close_channel?: (channel: ServerSecureChannelLayer) => void;
+    _on_connectionRefused?: (socketData: any) => void;
+    _on_openSecureChannelFailure?: (socketData: any, channelData: any) => void;
+    private _certificateChain;
+    private _privateKey;
+    private _channels;
+    private _server?;
+    private _endpoints;
+    private _listen_callback?;
+    private _started;
+    private _counter;
+    private _policy_deduplicator;
+    constructor(options: OPCUAServerEndPointOptions);
+    dispose(): void;
+    toString(): string;
+    getChannels(): ServerSecureChannelLayer[];
+    /**
+     * Returns the X509 DER form of the server certificate
+     */
+    getCertificate(): Certificate;
+    /**
+     * Returns the X509 DER form of the server certificate
+     */
+    getCertificateChain(): Certificate;
+    /**
+     * the private key
+     */
+    getPrivateKey(): PrivateKeyPEM;
+    /**
+     * The number of active channel on this end point.
+     */
+    get currentChannelCount(): number;
+    /**
+     * @method getEndpointDescription
+     * @param securityMode
+     * @param securityPolicy
+     * @return endpoint_description {EndpointDescription|null}
+     */
+    getEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, endpointUrl: string | null): EndpointDescription | null;
+    addEndpointDescription(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy, options?: EndpointDescriptionParams): void;
+    addRestrictedEndpointDescription(options: EndpointDescriptionParams): void;
+    addStandardEndpointDescriptions(options?: AddStandardEndpointDescriptionsParam): void;
+    /**
+     * returns the list of end point descriptions.
+     */
+    endpointDescriptions(): EndpointDescription[];
+    /**
+     * @method listen
+     * @async
+     */
+    listen(callback: (err?: Error) => void): void;
+    killClientSockets(callback: (err?: Error) => void): void;
+    suspendConnection(callback: (err?: Error) => void): void;
+    restoreConnection(callback: (err?: Error) => void): void;
+    abruptlyInterruptChannels(): void;
+    /**
+     * @method shutdown
+     * @async
+     */
+    shutdown(callback: (err?: Error) => void): void;
+    /**
+     * @method start
+     * @async
+     * @param callback
+     */
+    start(callback: (err?: Error) => void): void;
+    get bytesWritten(): number;
+    get bytesRead(): number;
+    get transactionsCount(): number;
+    get securityTokenCount(): number;
+    get activeChannelCount(): number;
+    private _dump_statistics;
+    private _setup_server;
+    private _on_client_connection;
+    private _preregisterChannel;
+    private _un_pre_registerChannel;
+    /**
+     * @method _registerChannel
+     * @param channel
+     * @private
+     */
+    private _registerChannel;
+    /**
+     * @method _unregisterChannel
+     * @param channel
+     * @private
+     */
+    private _unregisterChannel;
+    private _end_listen;
+    /**
+     *  shutdown_channel
+     * @param channel
+     * @param inner_callback
+     */
+    private shutdown_channel;
+    /**
+     * @private
+     */
+    private _prevent_DDOS_Attack;
+}