node-opcua-transport 2.64.1 → 2.65.0

package/dist/source/tcp_transport.d.ts

@@ -1,126 +1,126 @@
-/// <reference types="node" />
-/**
- * @module node-opcua-transport
- */
-import { EventEmitter } from "events";
-import { Socket } from "net";
-import { ErrorCallback, CallbackWithData } from "node-opcua-status-code";
-export interface MockSocket {
-    invalid?: boolean;
-    [key: string]: any;
-    destroy(): void;
-    end(): void;
-}
-export declare function setFakeTransport(mockSocket: MockSocket): void;
-export declare function getFakeTransport(): any;
-export interface TCP_transport {
-    on(eventName: "message", eventHandler: (message: Buffer) => void): this;
-    on(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
-    on(eventName: "close", eventHandler: (err: Error | null) => void): this;
-    once(eventName: "message", eventHandler: (message: Buffer) => void): this;
-    once(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
-    once(eventName: "close", eventHandler: (err: Error | null) => void): this;
-}
-export declare class TCP_transport extends EventEmitter {
-    private static registry;
-    /**
-     * indicates the version number of the OPCUA protocol used
-     * @default  0
-     */
-    protocolVersion: number;
-    bytesWritten: number;
-    bytesRead: number;
-    chunkWrittenCount: number;
-    chunkReadCount: number;
-    name: string;
-    _socket: Socket | null;
-    /**
-     * the size of the header in bytes
-     * @default  8
-     */
-    private readonly headerSize;
-    private _disconnecting;
-    private _timerId;
-    private _onSocketClosedHasBeenCalled;
-    private _onSocketEndedHasBeenCalled;
-    private _theCallback?;
-    private _on_error_during_one_time_message_receiver;
-    private _pendingBuffer?;
-    private packetAssembler?;
-    private _timeout;
-    constructor();
-    get timeout(): number;
-    set timeout(value: number);
-    dispose(): void;
-    /**
-     * ```createChunk``` is used to construct a pre-allocated chunk to store up to ```length``` bytes of data.
-     * The created chunk includes a prepended header for ```chunk_type``` of size ```self.headerSize```.
-     *
-     * @method createChunk
-     * @param msgType
-     * @param chunkType {String} chunk type. should be 'F' 'C' or 'A'
-     * @param length
-     * @return a buffer object with the required length representing the chunk.
-     *
-     * Note:
-     *  - only one chunk can be created at a time.
-     *  - a created chunk should be committed using the ```write``` method before an other one is created.
-     */
-    createChunk(msgType: string, chunkType: string, length: number): Buffer;
-    /**
-     * write the message_chunk on the socket.
-     * @method write
-     * @param messageChunk
-     *
-     * Notes:
-     *  - the message chunk must have been created by ```createChunk```.
-     *  - once a message chunk has been written, it is possible to call ```createChunk``` again.
-     *
-     */
-    write(messageChunk: Buffer): void;
-    get isDisconnecting(): boolean;
-    /**
-     * disconnect the TCP layer and close the underlying socket.
-     * The ```"close"``` event will be emitted to the observers with err=null.
-     *
-     * @method disconnect
-     * @async
-     * @param callback
-     */
-    disconnect(callback: ErrorCallback): void;
-    isValid(): boolean;
-    protected _write_chunk(messageChunk: Buffer): void;
-    protected on_socket_ended(err: Error | null): void;
-    /**
-     * @method _install_socket
-     * @param socket {Socket}
-     * @protected
-     */
-    protected _install_socket(socket: Socket): void;
-    prematureTerminate(err: Error): void;
-    /**
-     * @method _install_one_time_message_receiver
-     *
-     * install a one time message receiver callback
-     *
-     * Rules:
-     * * TCP_transport will not emit the ```message``` event, while the "one time message receiver" is in operation.
-     * * the TCP_transport will wait for the next complete message chunk and call the provided callback func
-     *   ```callback(null,messageChunk);```
-     *
-     * if a messageChunk is not received within ```TCP_transport.timeout``` or if the underlying socket reports
-     * an error, the callback function will be called with an Error.
-     *
-     */
-    protected _install_one_time_message_receiver(callback: CallbackWithData): void;
-    private _fulfill_pending_promises;
-    private _on_message_received;
-    private _cleanup_timers;
-    private _start_one_time_message_receiver;
-    private on_socket_closed;
-    private _on_socket_data;
-    private _on_socket_close;
-    private _on_socket_ended_message;
-    private _on_socket_end;
-    private _on_socket_error;
-}
+/// <reference types="node" />
+/**
+ * @module node-opcua-transport
+ */
+import { EventEmitter } from "events";
+import { Socket } from "net";
+import { ErrorCallback, CallbackWithData } from "node-opcua-status-code";
+export interface MockSocket {
+    invalid?: boolean;
+    [key: string]: any;
+    destroy(): void;
+    end(): void;
+}
+export declare function setFakeTransport(mockSocket: MockSocket): void;
+export declare function getFakeTransport(): any;
+export interface TCP_transport {
+    on(eventName: "message", eventHandler: (message: Buffer) => void): this;
+    on(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
+    on(eventName: "close", eventHandler: (err: Error | null) => void): this;
+    once(eventName: "message", eventHandler: (message: Buffer) => void): this;
+    once(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
+    once(eventName: "close", eventHandler: (err: Error | null) => void): this;
+}
+export declare class TCP_transport extends EventEmitter {
+    private static registry;
+    /**
+     * indicates the version number of the OPCUA protocol used
+     * @default  0
+     */
+    protocolVersion: number;
+    bytesWritten: number;
+    bytesRead: number;
+    chunkWrittenCount: number;
+    chunkReadCount: number;
+    name: string;
+    _socket: Socket | null;
+    /**
+     * the size of the header in bytes
+     * @default  8
+     */
+    private readonly headerSize;
+    private _disconnecting;
+    private _timerId;
+    private _onSocketClosedHasBeenCalled;
+    private _onSocketEndedHasBeenCalled;
+    private _theCallback?;
+    private _on_error_during_one_time_message_receiver;
+    private _pendingBuffer?;
+    private packetAssembler?;
+    private _timeout;
+    constructor();
+    get timeout(): number;
+    set timeout(value: number);
+    dispose(): void;
+    /**
+     * ```createChunk``` is used to construct a pre-allocated chunk to store up to ```length``` bytes of data.
+     * The created chunk includes a prepended header for ```chunk_type``` of size ```self.headerSize```.
+     *
+     * @method createChunk
+     * @param msgType
+     * @param chunkType {String} chunk type. should be 'F' 'C' or 'A'
+     * @param length
+     * @return a buffer object with the required length representing the chunk.
+     *
+     * Note:
+     *  - only one chunk can be created at a time.
+     *  - a created chunk should be committed using the ```write``` method before an other one is created.
+     */
+    createChunk(msgType: string, chunkType: string, length: number): Buffer;
+    /**
+     * write the message_chunk on the socket.
+     * @method write
+     * @param messageChunk
+     *
+     * Notes:
+     *  - the message chunk must have been created by ```createChunk```.
+     *  - once a message chunk has been written, it is possible to call ```createChunk``` again.
+     *
+     */
+    write(messageChunk: Buffer): void;
+    get isDisconnecting(): boolean;
+    /**
+     * disconnect the TCP layer and close the underlying socket.
+     * The ```"close"``` event will be emitted to the observers with err=null.
+     *
+     * @method disconnect
+     * @async
+     * @param callback
+     */
+    disconnect(callback: ErrorCallback): void;
+    isValid(): boolean;
+    protected _write_chunk(messageChunk: Buffer): void;
+    protected on_socket_ended(err: Error | null): void;
+    /**
+     * @method _install_socket
+     * @param socket {Socket}
+     * @protected
+     */
+    protected _install_socket(socket: Socket): void;
+    prematureTerminate(err: Error): void;
+    /**
+     * @method _install_one_time_message_receiver
+     *
+     * install a one time message receiver callback
+     *
+     * Rules:
+     * * TCP_transport will not emit the ```message``` event, while the "one time message receiver" is in operation.
+     * * the TCP_transport will wait for the next complete message chunk and call the provided callback func
+     *   ```callback(null,messageChunk);```
+     *
+     * if a messageChunk is not received within ```TCP_transport.timeout``` or if the underlying socket reports
+     * an error, the callback function will be called with an Error.
+     *
+     */
+    protected _install_one_time_message_receiver(callback: CallbackWithData): void;
+    private _fulfill_pending_promises;
+    private _on_message_received;
+    private _cleanup_timers;
+    private _start_one_time_message_receiver;
+    private on_socket_closed;
+    private _on_socket_data;
+    private _on_socket_close;
+    private _on_socket_ended_message;
+    private _on_socket_end;
+    private _on_socket_error;
+}