node-opcua-transport 2.51.0

package/dist/source/server_tcp_transport.d.ts

@@ -0,0 +1,45 @@
+/// <reference types="node" />
+import { Socket } from "net";
+import { StatusCode } from "node-opcua-status-code";
+import { ErrorCallback } from "node-opcua-status-code";
+import { TCP_transport } from "./tcp_transport";
+/**
+ * @class ServerTCP_transport
+ * @extends TCP_transport
+ * @constructor
+ *
+ */
+export declare class ServerTCP_transport extends TCP_transport {
+    static throttleTime: number;
+    receiveBufferSize: number;
+    sendBufferSize: number;
+    maxMessageSize: number;
+    maxChunkCount: number;
+    protocolVersion: number;
+    private _aborted;
+    private _helloReceived;
+    constructor();
+    protected _write_chunk(messageChunk: Buffer): void;
+    /**
+     * Initialize the server transport.
+     *
+     *
+     *  The ServerTCP_transport initialization process starts by waiting for the client to send a "HEL" message.
+     *
+     *  The  ServerTCP_transport replies with a "ACK" message and then start waiting for further messages of any size.
+     *
+     *  The callback function received an error:
+     *   - if no message from the client is received within the ```self.timeout``` period,
+     *   - or, if the connection has dropped within the same interval.
+     *   - if the protocol version specified within the HEL message is invalid or is greater
+     *     than ```self.protocolVersion```
+     *
+     *
+     */
+    init(socket: Socket, callback: ErrorCallback): void;
+    abortWithError(statusCode: StatusCode, extraErrorDescription: string, callback: ErrorCallback): void;
+    private _abortWithError;
+    private _send_ACK_response;
+    private _install_HEL_message_receiver;
+    private _on_HEL_message;
+}

package/dist/source/server_tcp_transport.js

@@ -0,0 +1,232 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServerTCP_transport = void 0;
+/**
+ * @module node-opcua-transport
+ */
+// tslint:disable:class-name
+// system
+const chalk = require("chalk");
+const node_opcua_assert_1 = require("node-opcua-assert");
+// opcua requires
+const node_opcua_binary_stream_1 = require("node-opcua-binary-stream");
+const node_opcua_chunkmanager_1 = require("node-opcua-chunkmanager");
+const node_opcua_status_code_1 = require("node-opcua-status-code");
+// this package requires
+const AcknowledgeMessage_1 = require("./AcknowledgeMessage");
+const HelloMessage_1 = require("./HelloMessage");
+const tcp_transport_1 = require("./tcp_transport");
+const TCPErrorMessage_1 = require("./TCPErrorMessage");
+const tools_1 = require("./tools");
+const debug = require("node-opcua-debug");
+const utils_1 = require("./utils");
+const hexDump = debug.hexDump;
+const debugLog = debug.make_debugLog(__filename);
+const errorLog = debug.make_errorLog(__filename);
+const doDebug = debug.checkDebugFlag(__filename);
+function clamp_value(value, minVal, maxVal) {
+    (0, node_opcua_assert_1.assert)(minVal < maxVal);
+    if (value === 0) {
+        return maxVal;
+    }
+    if (value < minVal) {
+        return minVal;
+    }
+    /* istanbul ignore next*/
+    if (value >= maxVal) {
+        return maxVal;
+    }
+    return value;
+}
+const minimumBufferSize = 8192;
+/**
+ * @class ServerTCP_transport
+ * @extends TCP_transport
+ * @constructor
+ *
+ */
+class ServerTCP_transport extends tcp_transport_1.TCP_transport {
+    constructor() {
+        super();
+        this._aborted = 0;
+        this._helloReceived = false;
+        this.receiveBufferSize = 0;
+        this.sendBufferSize = 0;
+        this.maxMessageSize = 0;
+        this.maxChunkCount = 0;
+        this.protocolVersion = 0;
+    }
+    _write_chunk(messageChunk) {
+        if (this.sendBufferSize > 0 && messageChunk.length > this.sendBufferSize) {
+            errorLog("write chunk exceed sendBufferSize messageChunk length = ", messageChunk.length, "sendBufferSize = ", this.sendBufferSize);
+        }
+        super._write_chunk(messageChunk);
+    }
+    /**
+     * Initialize the server transport.
+     *
+     *
+     *  The ServerTCP_transport initialization process starts by waiting for the client to send a "HEL" message.
+     *
+     *  The  ServerTCP_transport replies with a "ACK" message and then start waiting for further messages of any size.
+     *
+     *  The callback function received an error:
+     *   - if no message from the client is received within the ```self.timeout``` period,
+     *   - or, if the connection has dropped within the same interval.
+     *   - if the protocol version specified within the HEL message is invalid or is greater
+     *     than ```self.protocolVersion```
+     *
+     *
+     */
+    init(socket, callback) {
+        if (debugLog) {
+            debugLog(chalk.cyan("init socket"));
+        }
+        (0, node_opcua_assert_1.assert)(!this._socket, "init already called!");
+        (0, node_opcua_assert_1.assert)(typeof callback === "function", "expecting a valid callback ");
+        this._install_socket(socket);
+        this._install_HEL_message_receiver(callback);
+    }
+    abortWithError(statusCode, extraErrorDescription, callback) {
+        return this._abortWithError(statusCode, extraErrorDescription, callback);
+    }
+    _abortWithError(statusCode, extraErrorDescription, callback) {
+        if (debugLog) {
+            debugLog(chalk.cyan("_abortWithError"));
+        }
+        (0, node_opcua_assert_1.assert)(typeof callback === "function", "expecting a callback");
+        /* istanbul ignore else */
+        if (!this._aborted) {
+            this._aborted = 1;
+            setTimeout(() => {
+                // send the error message and close the connection
+                (0, node_opcua_assert_1.assert)(node_opcua_status_code_1.StatusCodes.hasOwnProperty(statusCode.name));
+                /* istanbul ignore next*/
+                if (doDebug) {
+                    debugLog(chalk.red(" Server aborting because ") + chalk.cyan(statusCode.name));
+                    debugLog(chalk.red(" extraErrorDescription   ") + chalk.cyan(extraErrorDescription));
+                }
+                const errorResponse = new TCPErrorMessage_1.TCPErrorMessage({
+                    reason: statusCode.description,
+                    statusCode
+                });
+                const messageChunk = (0, tools_1.packTcpMessage)("ERR", errorResponse);
+                this.write(messageChunk);
+                this.disconnect(() => {
+                    this._aborted = 2;
+                    callback(new Error(extraErrorDescription + " StatusCode = " + statusCode.name));
+                });
+            }, ServerTCP_transport.throttleTime);
+        }
+        else {
+            callback(new Error(statusCode.name));
+        }
+    }
+    _send_ACK_response(helloMessage) {
+        (0, node_opcua_assert_1.assert)(helloMessage.receiveBufferSize >= minimumBufferSize);
+        (0, node_opcua_assert_1.assert)(helloMessage.sendBufferSize >= minimumBufferSize);
+        this.receiveBufferSize = clamp_value(helloMessage.receiveBufferSize, 8192, 512 * 1024);
+        this.sendBufferSize = clamp_value(helloMessage.sendBufferSize, 8192, 512 * 1024);
+        this.maxMessageSize = clamp_value(helloMessage.maxMessageSize, 100000, 64 * 1024 * 1024);
+        this.maxChunkCount = clamp_value(helloMessage.maxChunkCount, 0, 65535);
+        // istanbul ignore next
+        if (utils_1.doTraceHelloAck) {
+            console.log(`received Hello \n${helloMessage.toString()}`);
+        }
+        debugLog("Client accepts only message of size => ", this.maxMessageSize);
+        const acknowledgeMessage = new AcknowledgeMessage_1.AcknowledgeMessage({
+            maxChunkCount: this.maxChunkCount,
+            maxMessageSize: this.maxMessageSize,
+            protocolVersion: this.protocolVersion,
+            receiveBufferSize: this.receiveBufferSize,
+            sendBufferSize: this.sendBufferSize
+        });
+        // istanbul ignore next
+        if (utils_1.doTraceHelloAck) {
+            console.log(`sending Ack \n${acknowledgeMessage.toString()}`);
+        }
+        const messageChunk = (0, tools_1.packTcpMessage)("ACK", acknowledgeMessage);
+        /* istanbul ignore next*/
+        if (doDebug) {
+            (0, node_opcua_chunkmanager_1.verify_message_chunk)(messageChunk);
+            debugLog("server send: " + chalk.yellow("ACK"));
+            debugLog("server send: " + hexDump(messageChunk));
+            debugLog("acknowledgeMessage=", acknowledgeMessage);
+        }
+        // send the ACK reply
+        this.write(messageChunk);
+    }
+    _install_HEL_message_receiver(callback) {
+        if (debugLog) {
+            debugLog(chalk.cyan("_install_HEL_message_receiver "));
+        }
+        this._install_one_time_message_receiver((err, data) => {
+            if (err) {
+                this._abortWithError(node_opcua_status_code_1.StatusCodes.BadConnectionRejected, err.message, callback);
+            }
+            else {
+                // handle the HEL message
+                this._on_HEL_message(data, callback);
+            }
+        });
+    }
+    _on_HEL_message(data, callback) {
+        if (debugLog) {
+            debugLog(chalk.cyan("_on_HEL_message"));
+        }
+        (0, node_opcua_assert_1.assert)(!this._helloReceived);
+        const stream = new node_opcua_binary_stream_1.BinaryStream(data);
+        const msgType = data.slice(0, 3).toString("ascii");
+        /* istanbul ignore next*/
+        if (doDebug) {
+            debugLog("SERVER received " + chalk.yellow(msgType));
+            debugLog("SERVER received " + hexDump(data));
+        }
+        if (msgType === "HEL") {
+            try {
+                (0, node_opcua_assert_1.assert)(data.length >= 24);
+                const helloMessage = (0, tools_1.decodeMessage)(stream, HelloMessage_1.HelloMessage);
+                (0, node_opcua_assert_1.assert)(isFinite(this.protocolVersion));
+                // OPCUA Spec 1.03 part 6 - page 41
+                // The Server shall always accept versions greater than what it supports.
+                if (helloMessage.protocolVersion !== this.protocolVersion) {
+                    debugLog(`warning ! client sent helloMessage.protocolVersion = ` +
+                        ` 0x${helloMessage.protocolVersion.toString(16)} ` +
+                        `whereas server protocolVersion is 0x${this.protocolVersion.toString(16)}`);
+                }
+                if (helloMessage.protocolVersion === 0xdeadbeef || helloMessage.protocolVersion < this.protocolVersion) {
+                    // Note: 0xDEADBEEF is our special version number to simulate BadProtocolVersionUnsupported in tests
+                    // invalid protocol version requested by client
+                    return this._abortWithError(node_opcua_status_code_1.StatusCodes.BadProtocolVersionUnsupported, "Protocol Version Error" + this.protocolVersion, callback);
+                }
+                // OPCUA Spec 1.04 part 6 - page 45
+                // UASC is designed to operate with different TransportProtocols that may have limited buffer
+                // sizes. For this reason, OPC UA Secure Conversation will break OPC UA Messages into several
+                // pieces (called ‘MessageChunks’) that are smaller than the buffer size allowed by the
+                // TransportProtocol. UASC requires a TransportProtocol buffer size that is at least 8 192 bytes
+                if (helloMessage.receiveBufferSize < minimumBufferSize || helloMessage.sendBufferSize < minimumBufferSize) {
+                    return this._abortWithError(node_opcua_status_code_1.StatusCodes.BadConnectionRejected, "Buffer size too small (should be at least " + minimumBufferSize, callback);
+                }
+                // the helloMessage shall only be received once.
+                this._helloReceived = true;
+                this._send_ACK_response(helloMessage);
+            }
+            catch (err) {
+                // connection rejected because of malformed message
+                return this._abortWithError(node_opcua_status_code_1.StatusCodes.BadConnectionRejected, err instanceof Error ? err.message : "", callback);
+            }
+            callback(); // no Error
+        }
+        else {
+            // invalid packet , expecting HEL
+            /* istanbul ignore next*/
+            if (doDebug) {
+                debugLog(chalk.red("BadCommunicationError ") + "Expecting 'HEL' message to initiate communication");
+            }
+            this._abortWithError(node_opcua_status_code_1.StatusCodes.BadCommunicationError, "Expecting 'HEL' message to initiate communication", callback);
+        }
+    }
+}
+exports.ServerTCP_transport = ServerTCP_transport;
+ServerTCP_transport.throttleTime = 1000;
+//# sourceMappingURL=server_tcp_transport.js.map

package/dist/source/server_tcp_transport.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"server_tcp_transport.js","sourceRoot":"","sources":["../../source/server_tcp_transport.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,4BAA4B;AAC5B,SAAS;AACT,+BAA+B;AAE/B,yDAA2C;AAE3C,iBAAiB;AACjB,uEAAwD;AACxD,qEAA+D;AAC/D,mEAAiE;AAGjE,wBAAwB;AACxB,6DAA0D;AAC1D,iDAA8C;AAC9C,mDAAgD;AAChD,uDAAoD;AACpD,mCAAwD;AAExD,0CAA0C;AAC1C,mCAA0C;AAE1C,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC;AAC9B,MAAM,QAAQ,GAAG,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AACjD,MAAM,QAAQ,GAAG,KAAK,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AACjD,MAAM,OAAO,GAAG,KAAK,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC;AAIjD,SAAS,WAAW,CAAC,KAAa,EAAE,MAAc,EAAE,MAAc;IAC9D,IAAA,0BAAM,EAAC,MAAM,GAAG,MAAM,CAAC,CAAC;IACxB,IAAI,KAAK,KAAK,CAAC,EAAE;QACb,OAAO,MAAM,CAAC;KACjB;IACD,IAAI,KAAK,GAAG,MAAM,EAAE;QAChB,OAAO,MAAM,CAAC;KACjB;IACD,yBAAyB;IACzB,IAAI,KAAK,IAAI,MAAM,EAAE;QACjB,OAAO,MAAM,CAAC;KACjB;IACD,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,MAAM,iBAAiB,GAAG,IAAI,CAAC;AAE/B;;;;;GAKG;AACH,MAAa,mBAAoB,SAAQ,6BAAa;IAYlD;QACI,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;QAClB,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;QAC5B,IAAI,CAAC,iBAAiB,GAAG,CAAC,CAAC;QAC3B,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,cAAc,GAAG,CAAC,CAAC;QACxB,IAAI,CAAC,aAAa,GAAG,CAAC,CAAC;QACvB,IAAI,CAAC,eAAe,GAAG,CAAC,CAAC;IAC7B,CAAC;IAES,YAAY,CAAC,YAAoB;QACvC,IAAI,IAAI,CAAC,cAAc,GAAG,CAAC,IAAI,YAAY,CAAC,MAAM,GAAG,IAAI,CAAC,cAAc,EAAE;YACtE,QAAQ,CACJ,0DAA0D,EAC1D,YAAY,CAAC,MAAM,EACnB,mBAAmB,EACnB,IAAI,CAAC,cAAc,CACtB,CAAC;SACL;QACD,KAAK,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACrC,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACI,IAAI,CAAC,MAAc,EAAE,QAAuB;QAC/C,IAAI,QAAQ,EAAE;YACV,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC;SACvC;QACD,IAAA,0BAAM,EAAC,CAAC,IAAI,CAAC,OAAO,EAAE,sBAAsB,CAAC,CAAC;QAC9C,IAAA,0BAAM,EAAC,OAAO,QAAQ,KAAK,UAAU,EAAE,6BAA6B,CAAC,CAAC;QACtE,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAI,CAAC,6BAA6B,CAAC,QAAQ,CAAC,CAAC;IACjD,CAAC;IAEM,cAAc,CAAC,UAAsB,EAAE,qBAA6B,EAAE,QAAuB;QAChG,OAAO,IAAI,CAAC,eAAe,CAAC,UAAU,EAAE,qBAAqB,EAAE,QAAQ,CAAC,CAAC;IAC7E,CAAC;IACO,eAAe,CAAC,UAAsB,EAAE,qBAA6B,EAAE,QAAuB;QAClG,IAAI,QAAQ,EAAE;YACV,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;SAC3C;QAED,IAAA,0BAAM,EAAC,OAAO,QAAQ,KAAK,UAAU,EAAE,sBAAsB,CAAC,CAAC;QAE/D,0BAA0B;QAC1B,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAChB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;YAClB,UAAU,CAAC,GAAG,EAAE;gBACZ,kDAAkD;gBAClD,IAAA,0BAAM,EAAC,oCAAW,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;gBAEpD,yBAAyB;gBACzB,IAAI,OAAO,EAAE;oBACT,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;oBAC/E,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,2BAA2B,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,CAAC;iBACxF;gBAED,MAAM,aAAa,GAAG,IAAI,iCAAe,CAAC;oBACtC,MAAM,EAAE,UAAU,CAAC,WAAW;oBAC9B,UAAU;iBACb,CAAC,CAAC;gBAEH,MAAM,YAAY,GAAG,IAAA,sBAAc,EAAC,KAAK,EAAE,aAAa,CAAC,CAAC;gBAE1D,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;gBAEzB,IAAI,CAAC,UAAU,CAAC,GAAG,EAAE;oBACjB,IAAI,CAAC,QAAQ,GAAG,CAAC,CAAC;oBAClB,QAAQ,CAAC,IAAI,KAAK,CAAC,qBAAqB,GAAG,gBAAgB,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpF,CAAC,CAAC,CAAC;YACP,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,CAAC;SACxC;aAAM;YACH,QAAQ,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC;SACxC;IACL,CAAC;IAEO,kBAAkB,CAAC,YAA0B;QACjD,IAAA,0BAAM,EAAC,YAAY,CAAC,iBAAiB,IAAI,iBAAiB,CAAC,CAAC;QAC5D,IAAA,0BAAM,EAAC,YAAY,CAAC,cAAc,IAAI,iBAAiB,CAAC,CAAC;QAEzD,IAAI,CAAC,iBAAiB,GAAG,WAAW,CAAC,YAAY,CAAC,iBAAiB,EAAE,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;QACvF,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,IAAI,EAAE,GAAG,GAAG,IAAI,CAAC,CAAC;QACjF,IAAI,CAAC,cAAc,GAAG,WAAW,CAAC,YAAY,CAAC,cAAc,EAAE,MAAM,EAAE,EAAE,GAAG,IAAI,GAAG,IAAI,CAAC,CAAC;QACzF,IAAI,CAAC,aAAa,GAAG,WAAW,CAAC,YAAY,CAAC,aAAa,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC;QAEvE,uBAAuB;QACvB,IAAI,uBAAe,EAAE;YACjB,OAAO,CAAC,GAAG,CAAC,oBAAoB,YAAY,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;SAC9D;QAED,QAAQ,CAAC,yCAAyC,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAEzE,MAAM,kBAAkB,GAAG,IAAI,uCAAkB,CAAC;YAC9C,aAAa,EAAE,IAAI,CAAC,aAAa;YACjC,cAAc,EAAE,IAAI,CAAC,cAAc;YACnC,eAAe,EAAE,IAAI,CAAC,eAAe;YACrC,iBAAiB,EAAE,IAAI,CAAC,iBAAiB;YACzC,cAAc,EAAE,IAAI,CAAC,cAAc;SACtC,CAAC,CAAC;QAEH,uBAAuB;QACvB,IAAI,uBAAe,EAAE;YACjB,OAAO,CAAC,GAAG,CAAC,iBAAiB,kBAAkB,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;SACjE;QAED,MAAM,YAAY,GAAG,IAAA,sBAAc,EAAC,KAAK,EAAE,kBAAkB,CAAC,CAAC;QAE/D,yBAAyB;QACzB,IAAI,OAAO,EAAE;YACT,IAAA,8CAAoB,EAAC,YAAY,CAAC,CAAC;YACnC,QAAQ,CAAC,eAAe,GAAG,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAChD,QAAQ,CAAC,eAAe,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC;YAClD,QAAQ,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAAC;SACvD;QAED,qBAAqB;QACrB,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC7B,CAAC;IAEO,6BAA6B,CAAC,QAAuB;QACzD,IAAI,QAAQ,EAAE;YACV,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAAC,CAAC;SAC1D;QACD,IAAI,CAAC,kCAAkC,CAAC,CAAC,GAAkB,EAAE,IAAa,EAAE,EAAE;YAC1E,IAAI,GAAG,EAAE;gBACL,IAAI,CAAC,eAAe,CAAC,oCAAW,CAAC,qBAAqB,EAAE,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;aAClF;iBAAM;gBACH,yBAAyB;gBACzB,IAAI,CAAC,eAAe,CAAC,IAAK,EAAE,QAAQ,CAAC,CAAC;aACzC;QACL,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,eAAe,CAAC,IAAY,EAAE,QAAuB;QACzD,IAAI,QAAQ,EAAE;YACV,QAAQ,CAAC,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,CAAC;SAC3C;QACD,IAAA,0BAAM,EAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7B,MAAM,MAAM,GAAG,IAAI,uCAAY,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;QAEnD,yBAAyB;QACzB,IAAI,OAAO,EAAE;YACT,QAAQ,CAAC,kBAAkB,GAAG,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;YACrD,QAAQ,CAAC,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC;SAChD;QAED,IAAI,OAAO,KAAK,KAAK,EAAE;YACnB,IAAI;gBACA,IAAA,0BAAM,EAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC;gBAC1B,MAAM,YAAY,GAAG,IAAA,qBAAa,EAAC,MAAM,EAAE,2BAAY,CAAiB,CAAC;gBACzE,IAAA,0BAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;gBAEvC,mCAAmC;gBACnC,yEAAyE;gBACzE,IAAI,YAAY,CAAC,eAAe,KAAK,IAAI,CAAC,eAAe,EAAE;oBACvD,QAAQ,CACJ,uDAAuD;wBACnD,MAAM,YAAY,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG;wBAClD,uCAAuC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CACjF,CAAC;iBACL;gBAED,IAAI,YAAY,CAAC,eAAe,KAAK,UAAU,IAAI,YAAY,CAAC,eAAe,GAAG,IAAI,CAAC,eAAe,EAAE;oBACpG,oGAAoG;oBACpG,+CAA+C;oBAC/C,OAAO,IAAI,CAAC,eAAe,CACvB,oCAAW,CAAC,6BAA6B,EACzC,wBAAwB,GAAG,IAAI,CAAC,eAAe,EAC/C,QAAQ,CACX,CAAC;iBACL;gBAED,mCAAmC;gBACnC,6FAA6F;gBAC7F,6FAA6F;gBAC7F,uFAAuF;gBACvF,gGAAgG;gBAChG,IAAI,YAAY,CAAC,iBAAiB,GAAG,iBAAiB,IAAI,YAAY,CAAC,cAAc,GAAG,iBAAiB,EAAE;oBACvG,OAAO,IAAI,CAAC,eAAe,CACvB,oCAAW,CAAC,qBAAqB,EACjC,4CAA4C,GAAG,iBAAiB,EAChE,QAAQ,CACX,CAAC;iBACL;gBACD,gDAAgD;gBAChD,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC;gBAC3B,IAAI,CAAC,kBAAkB,CAAC,YAAY,CAAC,CAAC;aACzC;YAAC,OAAO,GAAG,EAAE;gBACV,mDAAmD;gBACnD,OAAO,IAAI,CAAC,eAAe,CAAC,oCAAW,CAAC,qBAAqB,EAAE,GAAG,YAAY,KAAK,CAAE,CAAC,CAAC,GAAG,CAAC,OAAO,CAAA,CAAC,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;aACrH;YACD,QAAQ,EAAE,CAAC,CAAC,WAAW;SAC1B;aAAM;YACH,iCAAiC;YACjC,yBAAyB;YACzB,IAAI,OAAO,EAAE;gBACT,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,wBAAwB,CAAC,GAAG,mDAAmD,CAAC,CAAC;aACvG;YACD,IAAI,CAAC,eAAe,CAAC,oCAAW,CAAC,qBAAqB,EAAE,mDAAmD,EAAE,QAAQ,CAAC,CAAC;SAC1H;IACL,CAAC;;AAnOL,kDAoOC;AAnOiB,gCAAY,GAAW,IAAI,CAAC"}

package/dist/source/tcp_transport.d.ts

@@ -0,0 +1,117 @@
+/// <reference types="node" />
+import { EventEmitter } from "events";
+import { Socket } from "net";
+import { ErrorCallback, CallbackWithData } from "node-opcua-status-code";
+export declare function setFakeTransport(mockSocket: any): void;
+export declare function getFakeTransport(): any;
+export interface TCP_transport {
+    on(eventName: "message", eventHandler: (message: Buffer) => void): this;
+    once(eventName: "message", eventHandler: (message: Buffer) => void): this;
+    on(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
+    once(eventName: "socket_closed", eventHandler: (err: Error | null) => void): this;
+    on(eventName: "close", 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;
+}