WebSocket

@Websocket ဖြင့် IWebsocket handler သတ်မှတ်ရပါသည်၊ path အလိုက် WebsocketServer ကို inject လုပ်ပြီး client များသို့ text / binary ကို send သို့မဟုတ် brocast လုပ်နိုင်ပါသည်။

Define & register

@Websocket ဖြင့် decorate လုပ်ထားသော IWebsocket class ကို root module ၏ websocket တွင် မှတ်ပုံတင်ရပါသည်။ send / brocast အတွက် တူညီသော path ဖြင့် WebsocketServer ကို inject လုပ်ရပါသည်။

@Websocket({ path, ssl?, pingpongInterval? }) — URL path; pingpongInterval သည် keep-alive (ms)
@Module({ websocket: [ChatWebsocket] }) — handler ကို မှတ်ပုံတင်ပါသည်
@InjectWebsocketServer("/chat-websocket") — ထို path အတွက် server inject (handler / service / controller)
onAuthenticate — ClientInfo ({ id, … }) ပြန်လျှင် လက်ခံပါသည်; null ဆို ပယ်ချပါသည်

TSXhandler + module

import {
  InjectWebsocketServer,
  Module,
  Websocket,
  WebsocketServer,
} from "@quan-erp/shared-backend-core";
import type {
  ClientInfo,
  IWebsocket,
  WebsocketClient,
  WebsocketEvents,
} from "@quan-erp/shared-backend-core";
import type { IncomingMessage } from "http";
import type WebSocket from "ws";
import metadata from "../../module.metadata.json" with { type: "json" };

@Websocket({
  ssl: false,
  pingpongInterval: 1000,
  path: "/chat-websocket",
})
export class ChatWebsocket implements IWebsocket {
  @InjectWebsocketServer("/chat-websocket")
  websocket: WebsocketServer;

  onAuthenticate(ws: WebSocket, req: IncomingMessage): ClientInfo | null {
    return { id: "user-42" }; // null rejects the connection
  }

  on(
    event: WebsocketEvents,
    client: WebsocketClient,
    data: any,
    isBinary: boolean,
  ) {
    // see receive section
  }

  onUpgrade() {}
  onDestoryed() {}
}

@Module({
  name: metadata.name,
  providers: [],
  controllers: [],
  entities: [],
  websocket: [ChatWebsocket],
})
export class MyPluginModule {}

Message wrappers

Outbound payload သည် WebsocketMessage (getMessage()) ဖြစ်ရပါမည်။ Built-in wrapper များကို အသုံးပြုရပါသည် — sendText / brocast သို့ raw string မပို့ရပါ။

WebsocketTextEventMessage(event, payload) — JSON { event, payload }; app event အတွက် ဦးစားပေးရပါသည်
WebsocketTextMessage(data) — plain text / raw JSON string
WebsocketBinaryMessage(payload: Buffer) — binary Buffer

TSXwrappers

import {
  WebsocketBinaryMessage,
  WebsocketTextEventMessage,
  WebsocketTextMessage,
} from "@quan-erp/shared-backend-core";

new WebsocketTextEventMessage("kitchen", { orderId: 12 });
// → send/brocast as JSON: {"event":"kitchen","payload":{"orderId":12}}

new WebsocketTextMessage("Hello");
// → plain text frame

new WebsocketBinaryMessage(Buffer.from([0x01, 0x02]));
// → binary frame

Send text (client တစ်ဦး)

onAuthenticate မှ ClientInfo.id ဖြင့် ပစ်မှတ်ထားရပါသည်။ sendText သည် WebsocketTextEventMessage သို့မဟုတ် WebsocketTextMessage ကို လက်ခံပါသည်။

TSXsendText

import {
  InjectWebsocketServer,
  Service,
  WebsocketServer,
  WebsocketTextEventMessage,
  WebsocketTextMessage,
} from "@quan-erp/shared-backend-core";

@Service()
export class ChatPushService {
  @InjectWebsocketServer("/chat-websocket")
  private ws: WebsocketServer;

  notifyUser(userId: string) {
    this.ws.sendText(
      userId,
      new WebsocketTextEventMessage("inbox", {
        title: "New message",
      }),
    );

    this.ws.sendText(
      userId,
      new WebsocketTextMessage("ping"),
    );
  }
}

Send binary (client တစ်ဦး)

Buffer payload အတွက် sendBinary နှင့် WebsocketBinaryMessage ကို အသုံးပြုရပါသည်။

TSXsendBinary

import {
  InjectWebsocketServer,
  Service,
  WebsocketBinaryMessage,
  WebsocketServer,
} from "@quan-erp/shared-backend-core";

@Service()
export class FileStreamService {
  @InjectWebsocketServer("/chat-websocket")
  private ws: WebsocketServer;

  pushChunk(clientId: string, chunk: Buffer) {
    this.ws.sendBinary(
      clientId,
      new WebsocketBinaryMessage(chunk),
    );
  }
}

Brocast (client အားလုံး)

WebsocketServer.brocast (API စာလုံးပေါင်း brocast) သည် ထို path ပေါ်ရှိ client အားလုံးသို့ WebsocketMessage တစ်ခု ပို့ပါသည်။

Method name သည် brocast — broadcast မဟုတ်ပါ
Controller/service မှ domain write ပြီးနောက် အသုံးပြုနိုင်ပါသည်
Payload သည် WebsocketMessage wrapper ဖြစ်ရပါမည်

TSXbrocast from controller

import {
  Controller,
  InjectWebsocketServer,
  Post,
  ResponseDto,
  WebsocketServer,
  WebsocketTextEventMessage,
} from "@quan-erp/shared-backend-core";

@Controller("/order")
export class OrderController {
  @InjectWebsocketServer("/chat-websocket")
  private wsServer: WebsocketServer;

  @Post("/")
  async create() {
    // … persist order …
    this.wsServer.brocast(
      new WebsocketTextEventMessage("kitchen", "New Order"),
    );
    return ResponseDto.ok({ ok: true });
  }
}

TSXbrocast binary

import {
  WebsocketBinaryMessage,
  WebsocketServer,
} from "@quan-erp/shared-backend-core";

declare const ws: WebsocketServer;
ws.brocast(new WebsocketBinaryMessage(Buffer.from("raw-bytes")));

လက်ရှိ client သို့ raw send

on() အတွင်း client.getWebsocket().send(...) ဖြင့်လည်း ပို့နိုင်ပါသည်။ client id / brocast အတွက် WebsocketServer helper များကို ဦးစားပေးရပါသည်။

TSXraw send

import type { WebsocketClient } from "@quan-erp/shared-backend-core";
import { WebsocketTextEventMessage } from "@quan-erp/shared-backend-core";

function reply(client: WebsocketClient) {
  client
    .getWebsocket()
    .send(new WebsocketTextEventMessage("ack", { ok: true }).getMessage());
}

Text & binary လက်ခံခြင်း

on(event, client, data, isBinary) ကို lifecycle နှင့် frame များအတွက် ခေါ်ပါသည်။ WebsocketMessageHandler ဖြင့် structured text event ({ event, payload }) နှင့် generic message/close ကို ခွဲရပါသည်။ Binary သည် JSON event parse မလုပ်ပါ။

isBinary === false — data သည် string; event field ရှိ JSON ကို onTextEvent ဖြင့် ကိုက်ညီနိုင်ပါသည်
isBinary === true — binary; .on("message", …) သုံးရပါသည်
onTextEvent callback တွင် arg မရှိပါ — လိုအပ်လျှင် on() မှ data / client ကို close over လုပ်ရပါသည်
Chain အဆုံးတွင် .execute() ကို အမြဲ ခေါ်ရပါသည်

TSXreceive

import {
  InjectWebsocketServer,
  Websocket,
  WebsocketMessageHandler,
  WebsocketServer,
  WebsocketTextEventMessage,
} from "@quan-erp/shared-backend-core";
import type {
  IWebsocket,
  WebsocketClient,
  WebsocketEvents,
} from "@quan-erp/shared-backend-core";

@Websocket({ ssl: false, pingpongInterval: 1000, path: "/chat-websocket" })
export class ChatWebsocket implements IWebsocket {
  @InjectWebsocketServer("/chat-websocket")
  websocket: WebsocketServer;

  onAuthenticate() {
    return { id: "user-42" };
  }

  on(
    event: WebsocketEvents,
    client: WebsocketClient,
    data: any,
    isBinary: boolean,
  ) {
    new WebsocketMessageHandler(event, data, isBinary)
      .onTextEvent("chat-room", () => {
        const parsed = JSON.parse(String(data));
        this.websocket.brocast(
          new WebsocketTextEventMessage("chat-room", parsed.payload),
        );
      })
      .on("message", () => {
        if (isBinary) {
          // Buffer / ArrayBuffer-like frame in data
          return;
        }
        // plain text or non-event JSON
      })
      .on("close", () => {
        // client disconnected
      })
      .execute();
  }

  onUpgrade() {}
  onDestoryed() {}
}

Client များ စစ်ဆေးခြင်း

getAllClients() — ဤ path ပေါ်ရှိ WebsocketClient အားလုံး
getByClientId(id) — ထို id ၏ socket များ (array သို့မဟုတ် null)
client.getClientId() / getClientData() — onAuthenticate မှ identity

WebsocketServer API

sendText(clientId, WebsocketTextEventMessage | WebsocketTextMessage)
sendBinary(clientId, WebsocketBinaryMessage)
brocast(WebsocketMessage) — path ပေါ်ရှိ client အားလုံး
getByClientId(clientId) / getAllClients()