node-opcua-client 2.71.0 → 2.72.2

package/dist/private/client_base_impl.d.ts

@@ -1,169 +1,169 @@
-import { OPCUASecureObject } from "node-opcua-common";
-import { Certificate, Nonce } from "node-opcua-crypto";
-import { ClientSecureChannelLayer, ConnectionStrategy, ConnectionStrategyOptions, SecurityPolicy } from "node-opcua-secure-channel";
-import { ServerOnNetwork } from "node-opcua-service-discovery";
-import { ApplicationDescription, EndpointDescription } from "node-opcua-service-endpoints";
-import { MessageSecurityMode } from "node-opcua-service-secure-channel";
-import { ErrorCallback } from "node-opcua-status-code";
-import { OPCUACertificateManager } from "node-opcua-certificate-manager";
-import { ResponseCallback } from "../client_session";
-import { Request, Response } from "../common";
-import { CreateSecureChannelCallbackFunc, FindServersOnNetworkRequestLike, FindServersRequestLike, GetEndpointsOptions, OPCUAClientBase, OPCUAClientBaseOptions } from "../client_base";
-import { ClientSessionImpl } from "./client_session_impl";
-import { IClientBase } from "./i_private_client";
-declare type InternalClientState = "uninitialized" | "disconnected" | "connecting" | "connected" | "reconnecting" | "disconnecting";
-/**
- * @internal
- */
-export declare class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase, IClientBase {
-    /**
-     * total number of requests that been canceled due to timeout
-     * @property timedOutRequestCount
-     * @type {Number}
-     */
-    get timedOutRequestCount(): number;
-    /**
-     * total number of transactions performed by the client
-     * @property transactionsPerformed
-     * @type {Number}
-     */
-    get transactionsPerformed(): number;
-    /**
-     * is true when the client has already requested the server end points.
-     * @property knowsServerEndpoint
-     * @type boolean
-     */
-    get knowsServerEndpoint(): boolean;
-    /**
-     * true if the client is trying to reconnect to the server after a connection break.
-     * @property isReconnecting
-     * @type {Boolean}
-     */
-    get isReconnecting(): boolean;
-    /**
-     * true if the connection strategy is set to automatically try to reconnect in case of failure
-     * @property reconnectOnFailure
-     * @type {Boolean}
-     */
-    get reconnectOnFailure(): boolean;
-    /**
-     * total number of bytes read by the client
-     * @property bytesRead
-     * @type {Number}
-     */
-    get bytesRead(): number;
-    /**
-     * total number of bytes written by the client
-     * @property bytesWritten
-     * @type {Number}
-     */
-    get bytesWritten(): number;
-    securityMode: MessageSecurityMode;
-    securityPolicy: SecurityPolicy;
-    serverCertificate?: Certificate;
-    clientName: string;
-    protocolVersion: 0;
-    defaultSecureTokenLifetime: number;
-    tokenRenewalInterval: number;
-    connectionStrategy: ConnectionStrategy;
-    keepPendingSessionsOnDisconnect: boolean;
-    endpointUrl: string;
-    discoveryUrl: string;
-    readonly applicationName: string;
-    private _applicationUri;
-    /**
-     * true if session shall periodically probe the server to keep the session alive and prevent timeout
-     */
-    keepSessionAlive: boolean;
-    _sessions: ClientSessionImpl[];
-    protected _serverEndpoints: EndpointDescription[];
-    _secureChannel: ClientSecureChannelLayer | null;
-    protected disconnecting: boolean;
-    private _byteRead;
-    private _byteWritten;
-    private _timedOutRequestCount;
-    private _transactionsPerformed;
-    private reconnectionIsCanceled;
-    private _clockAdjuster?;
-    private _tmpClient?;
-    private _instanceNumber;
-    clientCertificateManager: OPCUACertificateManager;
-    protected _setInternalState(internalState: InternalClientState): void;
-    emit(eventName: string | symbol, ...others: any[]): boolean;
-    constructor(options?: OPCUAClientBaseOptions);
-    private _cancel_reconnection;
-    _recreate_secure_channel(callback: ErrorCallback): void;
-    _internal_create_secure_channel(connectionStrategy: ConnectionStrategyOptions, callback: CreateSecureChannelCallbackFunc): void;
-    static createCertificate(clientCertificateManager: OPCUACertificateManager, certificateFile: string, applicationName: string, applicationUri: string): Promise<void>;
-    createDefaultCertificate(): Promise<void>;
-    protected _getBuiltApplicationUri(): string;
-    protected initializeCM(): Promise<void>;
-    protected _internalState: InternalClientState;
-    protected _handleUnrecoverableConnectionFailure(err: Error, callback: ErrorCallback): void;
-    private _handleDisconnectionWhileConnecting;
-    private _handleSuccessfulConnection;
-    /**
-     * connect the OPC-UA client to a server end point.
-     * @async
-     */
-    connect(endpointUrl: string): Promise<void>;
-    connect(endpointUrl: string, callback: ErrorCallback): void;
-    /**
-     * @private
-     */
-    _connectStep2(endpointUrl: string, callback: ErrorCallback): void;
-    getClientNonce(): Nonce | null;
-    performMessageTransaction(request: Request, callback: ResponseCallback<Response>): void;
-    /**
-     *
-     * return the endpoint information matching  security mode and security policy.
-     * @method findEndpoint
-     */
-    findEndpointForSecurity(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): EndpointDescription | undefined;
-    /**
-     *
-     * return the endpoint information matching the specified url , security mode and security policy.
-     * @method findEndpoint
-     */
-    findEndpoint(endpointUrl: string, securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): EndpointDescription | undefined;
-    getEndpoints(options?: GetEndpointsOptions): Promise<EndpointDescription[]>;
-    getEndpoints(options: GetEndpointsOptions, callback: ResponseCallback<EndpointDescription[]>): void;
-    getEndpoints(callback: ResponseCallback<EndpointDescription[]>): void;
-    /**
-     * @deprecated
-     */
-    getEndpointsRequest(options: GetEndpointsOptions, callback: ResponseCallback<EndpointDescription[]>): void;
-    /**
-     * @method findServers
-     */
-    findServers(options?: FindServersRequestLike): Promise<ApplicationDescription[]>;
-    findServers(options: FindServersRequestLike, callback: ResponseCallback<ApplicationDescription[]>): void;
-    findServers(callback: ResponseCallback<ApplicationDescription[]>): void;
-    findServersOnNetwork(options?: FindServersOnNetworkRequestLike): Promise<ServerOnNetwork[]>;
-    findServersOnNetwork(callback: ResponseCallback<ServerOnNetwork[]>): void;
-    findServersOnNetwork(options: FindServersOnNetworkRequestLike, callback: ResponseCallback<ServerOnNetwork[]>): void;
-    _removeSession(session: ClientSessionImpl): void;
-    private _closeSession;
-    closeSession(...args: any[]): any;
-    disconnect(): Promise<void>;
-    disconnect(callback: ErrorCallback): void;
-    _on_connection_reestablished(callback: ErrorCallback): void;
-    toString(): string;
-    getSessions(): ClientSessionImpl[];
-    protected _addSession(session: ClientSessionImpl): void;
-    private fetchServerCertificate;
-    private _accumulate_statistics;
-    private _destroy_secure_channel;
-    private _close_pending_sessions;
-    private _install_secure_channel_event_handlers;
-    private _repairConnection;
-    private _finalReconnectionStep;
-    /**
-     *
-     * @internal
-     * @private
-     */
-    __createSession_step2(session: ClientSessionImpl, callback: (err: Error | null, session?: ClientSessionImpl) => void): void;
-    _activateSession(session: ClientSessionImpl, callback: (err: Error | null, session?: ClientSessionImpl) => void): void;
-}
-export {};
+import { OPCUASecureObject } from "node-opcua-common";
+import { Certificate, Nonce } from "node-opcua-crypto";
+import { ClientSecureChannelLayer, ConnectionStrategy, ConnectionStrategyOptions, SecurityPolicy } from "node-opcua-secure-channel";
+import { ServerOnNetwork } from "node-opcua-service-discovery";
+import { ApplicationDescription, EndpointDescription } from "node-opcua-service-endpoints";
+import { MessageSecurityMode } from "node-opcua-service-secure-channel";
+import { ErrorCallback } from "node-opcua-status-code";
+import { OPCUACertificateManager } from "node-opcua-certificate-manager";
+import { ResponseCallback } from "../client_session";
+import { Request, Response } from "../common";
+import { CreateSecureChannelCallbackFunc, FindServersOnNetworkRequestLike, FindServersRequestLike, GetEndpointsOptions, OPCUAClientBase, OPCUAClientBaseOptions } from "../client_base";
+import { ClientSessionImpl } from "./client_session_impl";
+import { IClientBase } from "./i_private_client";
+declare type InternalClientState = "uninitialized" | "disconnected" | "connecting" | "connected" | "reconnecting" | "disconnecting";
+/**
+ * @internal
+ */
+export declare class ClientBaseImpl extends OPCUASecureObject implements OPCUAClientBase, IClientBase {
+    /**
+     * total number of requests that been canceled due to timeout
+     * @property timedOutRequestCount
+     * @type {Number}
+     */
+    get timedOutRequestCount(): number;
+    /**
+     * total number of transactions performed by the client
+     * @property transactionsPerformed
+     * @type {Number}
+     */
+    get transactionsPerformed(): number;
+    /**
+     * is true when the client has already requested the server end points.
+     * @property knowsServerEndpoint
+     * @type boolean
+     */
+    get knowsServerEndpoint(): boolean;
+    /**
+     * true if the client is trying to reconnect to the server after a connection break.
+     * @property isReconnecting
+     * @type {Boolean}
+     */
+    get isReconnecting(): boolean;
+    /**
+     * true if the connection strategy is set to automatically try to reconnect in case of failure
+     * @property reconnectOnFailure
+     * @type {Boolean}
+     */
+    get reconnectOnFailure(): boolean;
+    /**
+     * total number of bytes read by the client
+     * @property bytesRead
+     * @type {Number}
+     */
+    get bytesRead(): number;
+    /**
+     * total number of bytes written by the client
+     * @property bytesWritten
+     * @type {Number}
+     */
+    get bytesWritten(): number;
+    securityMode: MessageSecurityMode;
+    securityPolicy: SecurityPolicy;
+    serverCertificate?: Certificate;
+    clientName: string;
+    protocolVersion: 0;
+    defaultSecureTokenLifetime: number;
+    tokenRenewalInterval: number;
+    connectionStrategy: ConnectionStrategy;
+    keepPendingSessionsOnDisconnect: boolean;
+    endpointUrl: string;
+    discoveryUrl: string;
+    readonly applicationName: string;
+    private _applicationUri;
+    /**
+     * true if session shall periodically probe the server to keep the session alive and prevent timeout
+     */
+    keepSessionAlive: boolean;
+    _sessions: ClientSessionImpl[];
+    protected _serverEndpoints: EndpointDescription[];
+    _secureChannel: ClientSecureChannelLayer | null;
+    protected disconnecting: boolean;
+    private _byteRead;
+    private _byteWritten;
+    private _timedOutRequestCount;
+    private _transactionsPerformed;
+    private reconnectionIsCanceled;
+    private _clockAdjuster?;
+    private _tmpClient?;
+    private _instanceNumber;
+    clientCertificateManager: OPCUACertificateManager;
+    protected _setInternalState(internalState: InternalClientState): void;
+    emit(eventName: string | symbol, ...others: any[]): boolean;
+    constructor(options?: OPCUAClientBaseOptions);
+    private _cancel_reconnection;
+    _recreate_secure_channel(callback: ErrorCallback): void;
+    _internal_create_secure_channel(connectionStrategy: ConnectionStrategyOptions, callback: CreateSecureChannelCallbackFunc): void;
+    static createCertificate(clientCertificateManager: OPCUACertificateManager, certificateFile: string, applicationName: string, applicationUri: string): Promise<void>;
+    createDefaultCertificate(): Promise<void>;
+    protected _getBuiltApplicationUri(): string;
+    protected initializeCM(): Promise<void>;
+    protected _internalState: InternalClientState;
+    protected _handleUnrecoverableConnectionFailure(err: Error, callback: ErrorCallback): void;
+    private _handleDisconnectionWhileConnecting;
+    private _handleSuccessfulConnection;
+    /**
+     * connect the OPC-UA client to a server end point.
+     * @async
+     */
+    connect(endpointUrl: string): Promise<void>;
+    connect(endpointUrl: string, callback: ErrorCallback): void;
+    /**
+     * @private
+     */
+    _connectStep2(endpointUrl: string, callback: ErrorCallback): void;
+    getClientNonce(): Nonce | null;
+    performMessageTransaction(request: Request, callback: ResponseCallback<Response>): void;
+    /**
+     *
+     * return the endpoint information matching  security mode and security policy.
+     * @method findEndpoint
+     */
+    findEndpointForSecurity(securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): EndpointDescription | undefined;
+    /**
+     *
+     * return the endpoint information matching the specified url , security mode and security policy.
+     * @method findEndpoint
+     */
+    findEndpoint(endpointUrl: string, securityMode: MessageSecurityMode, securityPolicy: SecurityPolicy): EndpointDescription | undefined;
+    getEndpoints(options?: GetEndpointsOptions): Promise<EndpointDescription[]>;
+    getEndpoints(options: GetEndpointsOptions, callback: ResponseCallback<EndpointDescription[]>): void;
+    getEndpoints(callback: ResponseCallback<EndpointDescription[]>): void;
+    /**
+     * @deprecated
+     */
+    getEndpointsRequest(options: GetEndpointsOptions, callback: ResponseCallback<EndpointDescription[]>): void;
+    /**
+     * @method findServers
+     */
+    findServers(options?: FindServersRequestLike): Promise<ApplicationDescription[]>;
+    findServers(options: FindServersRequestLike, callback: ResponseCallback<ApplicationDescription[]>): void;
+    findServers(callback: ResponseCallback<ApplicationDescription[]>): void;
+    findServersOnNetwork(options?: FindServersOnNetworkRequestLike): Promise<ServerOnNetwork[]>;
+    findServersOnNetwork(callback: ResponseCallback<ServerOnNetwork[]>): void;
+    findServersOnNetwork(options: FindServersOnNetworkRequestLike, callback: ResponseCallback<ServerOnNetwork[]>): void;
+    _removeSession(session: ClientSessionImpl): void;
+    private _closeSession;
+    closeSession(...args: any[]): any;
+    disconnect(): Promise<void>;
+    disconnect(callback: ErrorCallback): void;
+    _on_connection_reestablished(callback: ErrorCallback): void;
+    toString(): string;
+    getSessions(): ClientSessionImpl[];
+    protected _addSession(session: ClientSessionImpl): void;
+    private fetchServerCertificate;
+    private _accumulate_statistics;
+    private _destroy_secure_channel;
+    private _close_pending_sessions;
+    private _install_secure_channel_event_handlers;
+    private _repairConnection;
+    private _finalReconnectionStep;
+    /**
+     *
+     * @internal
+     * @private
+     */
+    __createSession_step2(session: ClientSessionImpl, callback: (err: Error | null, session?: ClientSessionImpl) => void): void;
+    _activateSession(session: ClientSessionImpl, callback: (err: Error | null, session?: ClientSessionImpl) => void): void;
+}
+export {};