@litert/televoke 1.0.3 → 1.1.0

package/lib/transporters/worker-thread/WorkerThread.Transporter.d.ts

@@ -0,0 +1,49 @@
+/**
+ * Copyright 2024 Angus.Fenying <fenying@litert.org>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import * as NodeWorker from 'node:worker_threads';
+import * as Shared from '../../shared';
+import type * as dT from '../Transporter.decl';
+import { EventEmitter } from 'node:events';
+declare abstract class AbstractThreadTransporter extends EventEmitter {
+    readonly protocol: string;
+    constructor(protocol: string);
+    getPropertyNames(): string[];
+    getAllProperties(): Record<string, unknown>;
+    getProperty(name: string): unknown;
+    abstract destroy(): void;
+    end(): void;
+    protected _write(worker: NodeWorker.MessagePort | NodeWorker.Worker, frame: Array<string | Buffer>): void;
+    protected _onMessage: (frame: unknown) => void;
+}
+export declare class MainThreadTransporter extends AbstractThreadTransporter implements dT.ITransporter, Shared.ITransporter {
+    protected readonly _worker: NodeWorker.Worker;
+    private _closed;
+    constructor(protocol: string, _worker: NodeWorker.Worker);
+    private readonly _onError;
+    private readonly _onExit;
+    destroy(): void;
+    get writable(): boolean;
+    write(frame: Array<string | Buffer>): void;
+}
+export declare class WorkerThreadTransporter extends AbstractThreadTransporter implements dT.ITransporter, Shared.ITransporter {
+    private _hold;
+    constructor(protocol: string);
+    destroy(): void;
+    get writable(): boolean;
+    write(frame: Array<string | Buffer>): void;
+}
+export {};
+//# sourceMappingURL=WorkerThread.Transporter.d.ts.map

package/lib/transporters/worker-thread/WorkerThread.Transporter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkerThread.Transporter.d.ts","sourceRoot":"","sources":["../../../src/lib/transporters/worker-thread/WorkerThread.Transporter.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,OAAO,KAAK,UAAU,MAAM,qBAAqB,CAAC;AAClD,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,KAAK,KAAK,EAAE,MAAM,qBAAqB,CAAC;AAE/C,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAC;AAM3C,uBAAe,yBAA0B,SAAQ,YAAY;aAGrC,QAAQ,EAAE,MAAM;gBAAhB,QAAQ,EAAE,MAAM;IAM7B,gBAAgB,IAAI,MAAM,EAAE;IAK5B,gBAAgB,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAW3C,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO;aAkBzB,OAAO,IAAI,IAAI;IAExB,GAAG,IAAI,IAAI;IAKlB,SAAS,CAAC,MAAM,CACZ,MAAM,EAAE,UAAU,CAAC,WAAW,GAAG,UAAU,CAAC,MAAM,EAClD,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAC9B,IAAI;IAsBP,SAAS,CAAC,UAAU,UAAW,OAAO,KAAG,IAAI,CAQ3C;CACL;AAED,qBAAa,qBAAsB,SAAQ,yBAA0B,YAAW,EAAE,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY;IAM5G,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC,MAAM;IAJjD,OAAO,CAAC,OAAO,CAAkB;gBAG7B,QAAQ,EAAE,MAAM,EACG,OAAO,EAAE,UAAU,CAAC,MAAM;IAWjD,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAoD;IAE7E,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAmC;IAEpD,OAAO,IAAI,IAAI;IAWtB,IAAW,QAAQ,IAAI,OAAO,CAG7B;IAEM,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI;CASpD;AAED,qBAAa,uBAAwB,SAAQ,yBAA0B,YAAW,EAAE,CAAC,YAAY,EAAE,MAAM,CAAC,YAAY;IAElH,OAAO,CAAC,KAAK,CAAmE;gBAE7D,QAAQ,EAAE,MAAM;IAY5B,OAAO,IAAI,IAAI;IAatB,IAAW,QAAQ,IAAI,OAAO,CAG7B;IAEM,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,IAAI;CASpD"}

package/lib/transporters/worker-thread/WorkerThread.Transporter.js

@@ -0,0 +1,140 @@
+"use strict";
+/**
+ * Copyright 2024 Angus.Fenying <fenying@litert.org>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WorkerThreadTransporter = exports.MainThreadTransporter = void 0;
+const NodeWorker = require("node:worker_threads");
+const Shared = require("../../shared");
+const eWT = require("./WorkerThread.Errors");
+const node_events_1 = require("node:events");
+const PROPERTY_NAMES = ['remoteAddress', 'remotePort', 'localAddress', 'localPort', 'threadId'];
+const MSG_PREFIX = 'televoke2://';
+class AbstractThreadTransporter extends node_events_1.EventEmitter {
+    constructor(protocol) {
+        super();
+        this.protocol = protocol;
+        this._onMessage = (frame) => {
+            if (typeof frame !== 'string' || !frame.startsWith(MSG_PREFIX)) {
+                return;
+            }
+            this.emit('frame', [Buffer.from(frame.slice(MSG_PREFIX.length), 'base64')]);
+        };
+    }
+    getPropertyNames() {
+        return PROPERTY_NAMES;
+    }
+    getAllProperties() {
+        return {
+            'remoteAddress': '127.0.0.1',
+            'remotePort': 0,
+            'localAddress': '127.0.0.1',
+            'localPort': 0,
+            'threadId': NodeWorker.threadId,
+        };
+    }
+    getProperty(name) {
+        switch (name) {
+            case 'localPort':
+                return 0;
+            case 'localAddress':
+                return '127.0.0.1';
+            case 'remotePort':
+                return 0;
+            case 'remoteAddress':
+                return '127.0.0.1';
+            case 'threadId':
+                return NodeWorker.threadId;
+            default:
+                return undefined;
+        }
+    }
+    end() {
+        this.destroy();
+    }
+    _write(worker, frame) {
+        for (let i = 0; i < frame.length; i++) {
+            const f = frame[i];
+            if (!(f instanceof Buffer)) {
+                frame[i] = Buffer.from(f);
+            }
+        }
+        try {
+            worker.postMessage(MSG_PREFIX + Buffer.concat(frame).toString('base64'));
+        }
+        catch (e) {
+            throw new Shared.errors.network_error({ reason: 'conn_lost', cause: e });
+        }
+    }
+}
+class MainThreadTransporter extends AbstractThreadTransporter {
+    constructor(protocol, _worker) {
+        super(protocol);
+        this._worker = _worker;
+        this._closed = false;
+        this._onError = (e) => { this.emit('error', e); };
+        this._onExit = () => { this.destroy(); };
+        this._worker
+            .on('message', this._onMessage)
+            .on('error', this._onError)
+            .on('exit', this._onExit);
+    }
+    destroy() {
+        this._closed = true;
+        this._worker.removeListener('message', this._onMessage);
+        this._worker.removeListener('error', this._onError);
+        this._worker.removeListener('exit', this._onExit);
+        this.emit('close');
+    }
+    get writable() {
+        return !this._closed;
+    }
+    write(frame) {
+        if (this._closed) {
+            throw new Shared.errors.network_error({ reason: 'conn_lost' });
+        }
+        this._write(this._worker, frame);
+    }
+}
+exports.MainThreadTransporter = MainThreadTransporter;
+class WorkerThreadTransporter extends AbstractThreadTransporter {
+    constructor(protocol) {
+        super(protocol);
+        this._hold = setInterval(() => { return; }, 3600000);
+        if (NodeWorker.isMainThread) {
+            throw new eWT.E_WORKER_THREAD_ONLY();
+        }
+        NodeWorker.parentPort.on('message', this._onMessage);
+    }
+    destroy() {
+        if (this._hold) {
+            clearInterval(this._hold);
+            this._hold = null;
+            NodeWorker.parentPort.removeListener('message', this._onMessage);
+            this.emit('close');
+        }
+    }
+    get writable() {
+        return !!this._hold;
+    }
+    write(frame) {
+        if (!this._hold) {
+            throw new Shared.errors.network_error({ reason: 'conn_lost' });
+        }
+        super._write(NodeWorker.parentPort, frame);
+    }
+}
+exports.WorkerThreadTransporter = WorkerThreadTransporter;
+//# sourceMappingURL=WorkerThread.Transporter.js.map

package/lib/transporters/worker-thread/WorkerThread.Transporter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"WorkerThread.Transporter.js","sourceRoot":"","sources":["../../../src/lib/transporters/worker-thread/WorkerThread.Transporter.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;AAEH,kDAAkD;AAClD,uCAAuC;AAEvC,6CAA6C;AAC7C,6CAA2C;AAE3C,MAAM,cAAc,GAAG,CAAC,eAAe,EAAE,YAAY,EAAE,cAAc,EAAE,WAAW,EAAE,UAAU,CAAC,CAAC;AAEhG,MAAM,UAAU,GAAG,cAAc,CAAC;AAElC,MAAe,yBAA0B,SAAQ,0BAAY;IAEzD,YACoB,QAAgB;QAGhC,KAAK,EAAE,CAAC;QAHQ,aAAQ,GAAR,QAAQ,CAAQ;QAwE1B,eAAU,GAAG,CAAC,KAAc,EAAQ,EAAE;YAE5C,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;gBAE7D,OAAO;YACX,CAAC;YAED,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC;QAChF,CAAC,CAAC;IA5EF,CAAC;IAEM,gBAAgB;QAEnB,OAAO,cAAc,CAAC;IAC1B,CAAC;IAEM,gBAAgB;QAEnB,OAAO;YACH,eAAe,EAAE,WAAW;YAC5B,YAAY,EAAE,CAAC;YACf,cAAc,EAAE,WAAW;YAC3B,WAAW,EAAE,CAAC;YACd,UAAU,EAAE,UAAU,CAAC,QAAQ;SAClC,CAAC;IACN,CAAC;IAEM,WAAW,CAAC,IAAY;QAE3B,QAAQ,IAAI,EAAE,CAAC;YACX,KAAK,WAAW;gBACZ,OAAO,CAAC,CAAC;YACb,KAAK,cAAc;gBACf,OAAO,WAAW,CAAC;YACvB,KAAK,YAAY;gBACb,OAAO,CAAC,CAAC;YACb,KAAK,eAAe;gBAChB,OAAO,WAAW,CAAC;YACvB,KAAK,UAAU;gBACX,OAAO,UAAU,CAAC,QAAQ,CAAC;YAC/B;gBACI,OAAO,SAAS,CAAC;QACzB,CAAC;IACL,CAAC;IAIM,GAAG;QAEN,IAAI,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC;IAES,MAAM,CACZ,MAAkD,EAClD,KAA6B;QAG7B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;YAEpC,MAAM,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;YAEnB,IAAI,CAAC,CAAC,CAAC,YAAY,MAAM,CAAC,EAAE,CAAC;gBAEzB,KAAK,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC;QACL,CAAC;QAED,IAAI,CAAC;YAED,MAAM,CAAC,WAAW,CAAC,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,KAAiB,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC;QACzF,CAAC;QACD,OAAO,CAAC,EAAE,CAAC;YAEP,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;QAC7E,CAAC;IACL,CAAC;CAWJ;AAED,MAAa,qBAAsB,SAAQ,yBAAyB;IAIhE,YACI,QAAgB,EACG,OAA0B;QAG7C,KAAK,CAAC,QAAQ,CAAC,CAAC;QAHG,YAAO,GAAP,OAAO,CAAmB;QAJzC,YAAO,GAAY,KAAK,CAAC;QAehB,aAAQ,GAAG,CAAC,CAAU,EAAQ,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5D,YAAO,GAAG,GAAS,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC;QARvD,IAAI,CAAC,OAAO;aACP,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC;aAC9B,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC;aAC1B,EAAE,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IAMM,OAAO;QAEV,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;QAEpB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACxD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QACpD,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QAElD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACvB,CAAC;IAED,IAAW,QAAQ;QAEf,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,KAA6B;QAEtC,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAEf,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACrC,CAAC;CACJ;AA9CD,sDA8CC;AAED,MAAa,uBAAwB,SAAQ,yBAAyB;IAIlE,YAAmB,QAAgB;QAE/B,KAAK,CAAC,QAAQ,CAAC,CAAC;QAJZ,UAAK,GAA0B,WAAW,CAAC,GAAG,EAAE,GAAG,OAAO,CAAC,CAAC,EAAE,OAAQ,CAAC,CAAC;QAM5E,IAAI,UAAU,CAAC,YAAY,EAAE,CAAC;YAE1B,MAAM,IAAI,GAAG,CAAC,oBAAoB,EAAE,CAAC;QACzC,CAAC;QAED,UAAU,CAAC,UAAW,CAAC,EAAE,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC1D,CAAC;IAEM,OAAO;QAEV,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAEb,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC1B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;YAElB,UAAU,CAAC,UAAW,CAAC,cAAc,CAAC,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;YAElE,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;IACL,CAAC;IAED,IAAW,QAAQ;QAEf,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;IACxB,CAAC;IAEM,KAAK,CAAC,KAA6B;QAEtC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YAEd,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;QACnE,CAAC;QAED,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,UAAW,EAAE,KAAK,CAAC,CAAC;IAChD,CAAC;CACJ;AA3CD,0DA2CC"}

package/lib/transporters/worker-thread/index.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright 2024 Angus.Fenying <fenying@litert.org>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export * from './WorkerThread.Client';
+export * from './WorkerThread.Server';
+export * from './WorkerThread.Constants';
+//# sourceMappingURL=index.d.ts.map

package/lib/transporters/worker-thread/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/transporters/worker-thread/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;GAcG;AAEH,cAAc,uBAAuB,CAAC;AACtC,cAAc,uBAAuB,CAAC;AACtC,cAAc,0BAA0B,CAAC"}

package/lib/transporters/worker-thread/index.js

@@ -0,0 +1,35 @@
+"use strict";
+/**
+ * Copyright 2024 Angus.Fenying <fenying@litert.org>
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./WorkerThread.Client"), exports);
+__exportStar(require("./WorkerThread.Server"), exports);
+__exportStar(require("./WorkerThread.Constants"), exports);
+//# sourceMappingURL=index.js.map

package/lib/transporters/worker-thread/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/transporters/worker-thread/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG;;;;;;;;;;;;;;;;AAEH,wDAAsC;AACtC,wDAAsC;AACtC,2DAAyC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@litert/televoke",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "A simple RPC service framework.",
   "main": "lib/index.js",
   "scripts": {

package/src/lib/server/LegacyServerChannel.impl.ts

@@ -32,6 +32,10 @@ export class TvLegacyServerChannelV1 extends EventEmitter implements Shared.ICha
 
     public get writable(): boolean { return false; }
 
+    public get isMessageSupported(): boolean { return false; }
+
+    public get isBinaryStreamSupported(): boolean { return false; }
+
     public get id(): number { return 0; }
 
     public get timeout(): number { return 30_000; }

package/src/lib/shared/Channel.impl.ts

@@ -88,6 +88,10 @@ export abstract class AbstractTvChannelV2
 
     public ended: boolean = false;
 
+    public get isMessageSupported(): boolean { return true; }
+
+    public get isBinaryStreamSupported(): boolean { return this.streams.maxStreams !== 0; }
+
     public get finished(): boolean {
 
         return this._state === EState.ENDED;

package/src/lib/shared/Encodings/v2/DecoderV2.ts

@@ -184,13 +184,31 @@ class TvErrorResponseDecoder implements IPacketDecoder {
 
         const errorMsg = readString(len, ctx);
 
+        let err: TelevokeError;
+
+        if (errorMsg.startsWith(CS.PROTOCOL_ERROR_NAMESPACE)) {
+
+            const errMsg = errorMsg.slice(CS.PROTOCOL_ERROR_NAMESPACE.length + 1);
+
+            if (errMsg in errors) {
+
+                err = new (errors as any)[errMsg]();
+            }
+            else {
+
+                err = new ProtocolError(errMsg, null, null);
+            }
+        }
+        else {
+
+            err = new errors.app_error(errorMsg.slice(CS.APP_ERROR_NAMESPACE.length + 1), null);
+        }
+
         return {
             'cmd': ctx.command,
             'typ': CSv2.EPacketType.ERROR_RESPONSE,
             'seq': ctx.seq,
-            'ct': errorMsg.startsWith(CS.PROTOCOL_ERROR_NAMESPACE) ?
-                new ProtocolError(errorMsg.slice(CS.PROTOCOL_ERROR_NAMESPACE.length + 1), null) :
-                new errors.app_error(errorMsg.slice(CS.APP_ERROR_NAMESPACE.length + 1), null),
+            'ct': err,
         } satisfies dEnc2.IErrorResponsePacket;
     }
 }

package/src/lib/shared/Errors.ts

@@ -36,6 +36,7 @@ export class ProtocolError extends TelevokeError {
 
     public constructor(
         message: string,
+        public readonly data: unknown,
         origin: unknown,
     ) {
 
@@ -52,9 +53,9 @@ function defineProtocolError<T extends string>(name: T): Record<T, new (
 
         [name]: class extends ProtocolError {
 
-            public constructor(public readonly data: unknown = null, origin: unknown = null) {
+            public constructor(data: unknown = null, origin: unknown = null) {
 
-                super(name, origin);
+                super(name, data, origin);
             }
         },
     } as any;

package/src/lib/shared/Shared.decl.ts

@@ -303,6 +303,16 @@ export interface IChannelBase<TEvents extends IDefaultEvents> extends IEventList
      */
     readonly transporter: ITransporter;
 
+    /**
+     * Whether this channel supports server-push messages or not.
+     */
+    readonly isMessageSupported: boolean;
+
+    /**
+     * Whether this channel supports binary streams or not.
+     */
+    readonly isBinaryStreamSupported: boolean;
+
     /**
      * Tells whether this channel is closed on the local side or not.
      */

package/src/lib/transporters/Transporter.decl.ts

@@ -89,7 +89,7 @@ export interface ITransporter extends Shared.IEventListener<ITransporterEvents>
      *
      * @param lastFrame The last frame.
      */
-    end(lastFrame?: Buffer | string | Array<Buffer | string>): void;
+    end(): void;
 
     /**
      * Destroy the transporter.
@@ -101,7 +101,7 @@ export interface ITransporter extends Shared.IEventListener<ITransporterEvents>
      *
      * @param frame The frame to write.
      */
-    write(frame: Buffer | string | Array<Buffer | string>): void;
+    write(frame: Array<Buffer | string>): void;
 }
 
 export interface IConnector {

package/src/lib/transporters/legacy-http/LegacyHttp.Server.ts

@@ -212,6 +212,19 @@ class LegacyHttpGateway extends EventEmitter implements dT.IGateway {
                                 recvAt
                             ));
                         }
+                        else if (result instanceof Shared.ProtocolError) {
+
+                            this._sendResponse(resp, encoder.encodeApiErrorResponse(
+                                input.rid,
+                                v1.EResponseCode.SYSTEM_ERROR,
+                                JSON.stringify({
+                                    name: result.name,
+                                    message: result.message,
+                                    data: result.data,
+                                }),
+                                recvAt
+                            ));
+                        }
                         else {
 
                             this._sendResponse(resp, encoder.encodeApiErrorResponse(

package/src/lib/transporters/legacy-http/README.md

@@ -0,0 +1,13 @@
+# Televoke1/Http
+
+This module provides the http/1.1 transporter for Televoke1 protocol. It's a compatibility module for Televoke1, working
+with the Televoke v1.x library.
+
+> It's okay to use the Televoke1 as a fallback if both Televoke1 and Televoke2 are used.
+
+## Examples
+
+- [Server](../../../examples/network/server.ts)
+- [Client over TCP](../../../examples/network/legacy-http-client.ts)
+- [Client over TLS](../../../examples/network/legacy-https-client.ts)
+- [Client over Unix Domain Socket](../../../examples/network/legacy-http-unix-client.ts)

package/src/lib/transporters/lwdfx/LwDFX.Transporter.ts

@@ -75,7 +75,7 @@ export class LwDFXTransporter extends EventEmitter implements dT.ITransporter, S
         return this._conn.connected;
     }
 
-    public write(frame: string | Buffer | Array<string | Buffer>): void {
+    public write(frame: Array<string | Buffer>): void {
 
         if (!this._conn.writable) {
 
@@ -85,15 +85,10 @@ export class LwDFXTransporter extends EventEmitter implements dT.ITransporter, S
         this._conn.write(frame);
     }
 
-    public end(frame?: Buffer | string): void {
+    public end(): void {
 
         if (this._conn.writable) {
 
-            if (frame) {
-
-                this._conn.write(frame);
-            }
-
             this._conn.end();
         }
     }

package/src/lib/transporters/lwdfx/README.md

@@ -0,0 +1,12 @@
+# Televoke2/LwDFX
+
+This module provides the Televoke2 protocol over LwDFXv1. It allows you to connect to the Televoke2 server with LwDFXv1.
+
+> `@litert/lwdfx` is required to use this module.
+
+## Examples
+
+- [Server](../../../examples/network/server.ts)
+- [Client over TCP](../../../examples/network/lwdfx-tcp-client.ts)
+- [Client over TLS](../../../examples/network/lwdfx-tls-client.ts)
+- [Client over Unix Domain Socket](../../../examples/network/lwdfx-unix-client.ts)

package/src/lib/transporters/memory/Memory.Impl.ts

@@ -176,18 +176,13 @@ class MemorySocket extends EventEmitter implements dT.ITransporter, Shared.ITran
         };
     }
 
-    public write(data: string | Buffer | Array<string | Buffer>): void {
+    public write(data: Array<string | Buffer>): void {
 
         if (this._exchange.isEnded(this._endpoint)) {
 
             throw new Shared.errors.network_error({ reason: 'conn_lost' });
         }
 
-        if (!Array.isArray(data)) {
-
-            data = [data];
-        }
-
         for (let i = 0; i < data.length; ++i) {
 
             if (!(data[i] instanceof Buffer)) {
@@ -204,12 +199,7 @@ class MemorySocket extends EventEmitter implements dT.ITransporter, Shared.ITran
         this._exchange.close();
     }
 
-    public end(lastChunk?: any): void {
-
-        if (lastChunk !== undefined) {
-
-            this.write(lastChunk);
-        }
+    public end(): void {
 
         this._exchange.end(this._endpoint);
     }

package/src/lib/transporters/memory/README.md

@@ -0,0 +1,7 @@
+# Televoke2/Memory
+
+This module provides the Televoke2 protocol in-memory. It allows you to simulate a server and client in the same process (thread).
+
+## Examples
+
+- [Go to examples](../../../examples/memory.ts)

package/src/lib/transporters/websocket/README.md

@@ -0,0 +1,14 @@
+# Televoke2/Websocket
+
+This module provides the Televoke2 protocol over websocket. It allows you to connect to the Televoke2 server with websocket.
+
+> `@litert/websocket` is required to use this module.
+>
+> And by default it uses unmasked data frames in client-side, which maybe incompatible with some server implementations. You could enable the mask feature by yourself, and improved the masking performance by use the `@litert/ws-utils` module, which is a C++ addon.
+
+## Examples
+
+- [Server](../../../examples/network/server.ts)
+- [Client over TCP](../../../examples/network/ws-client.ts)
+- [Client over TLS](../../../examples/network/wss-client.ts)
+- [Client over Unix Domain Socket](../../../examples/network/ws-unix-client.ts)

package/src/lib/transporters/websocket/WebSocket.Transporter.ts

@@ -93,7 +93,7 @@ export class WebSocketTransporter extends EventEmitter implements dT.ITransporte
         return this._conn.connected;
     }
 
-    public write(frame: string | Buffer | Array<string | Buffer>): void {
+    public write(frame: Array<string | Buffer>): void {
 
         if (!this._conn.writable) {
 
@@ -110,22 +110,10 @@ export class WebSocketTransporter extends EventEmitter implements dT.ITransporte
         }
     }
 
-    public end(frame?: Buffer | string): void {
+    public end(): void {
 
         if (this._conn.writable) {
 
-            if (frame) {
-
-                try {
-
-                    this._conn.writeBinary(frame);
-                }
-                catch (e) {
-
-                    throw new Shared.errors.network_error({ reason: 'conn_lost', cause: e });
-                }
-            }
-
             this._conn.end();
         }
     }

package/src/lib/transporters/worker-thread/README.md

@@ -0,0 +1,18 @@
+# Televoke2/WorkerThread
+
+This module provides the Televoke2 protocol over Node.js Worker Threads, which allows you to connect the main thread and
+worker threads with the Televoke2 protocol.
+
+You could either make the main thread as a server or a client, and the worker threads as clients or servers.
+
+## Examples
+
+- Main Thread As Server
+
+    - Check the [server code (main thread)](../../../examples/worker-thread/main-server.ts)
+    - Check the [client code (worker thread)](../../../examples/worker-thread/worker-client.ts)
+
+- Worker Thread As Server
+
+    - Check the [server code (worker thread)](../../../examples/worker-thread/worker-server.ts)
+    - Check the [client code (main thread)](../../../examples/worker-thread/main-client.ts)