WebSocket Server

Developers can launch a WebSocket Server during the game and provide an RPC interface. By improving and calling these RPC interfaces, developers can monitor the internal state of the game process and increase the ability to manage the game process state.

How To Enable

The WebSocket Server is disabled by default. To enable it, need to check the editor’s main menu Project -> Project Settings -> Feature Cropping , and enable the WebSocket Server configuration setting.

How to use WebSocket

Refer to the example code below:

  1. // In the native platform's Release mode or in Web / WeChat Mini Games and other platforms, WebSocketServer may not be defined.
  2. if (typeof WebSocketServer === "undefined") {
  3.     console.error("WebSocketServer is not enabled!");
  4.     return;
  5. }
  7. let s = new WebSocketServer();
  8. s.onconnection = function (conn) {
  9.     conn.onmessage = function (data) {
  10.         conn.send(data, (err) => {});
  11.     }
  12.     conn.onclose = function () {
  13.         console.log("connection gone!");
  14.     };
  15. };
  17. s.onclose = function () {
  18.   console.log("server is closed!");
  19. }
  20. s.listen(8080, (err) => {
  21.    if (!err);
  22.    console.log("server booted!");
  23. });

API

The interface is defined as follows

  1. /**
  2.  * Server object
  3.  */
  4. class WebSocketServer {
  5.     /**
  6.      * Close the server
  7.      */
  8.     close(cb?: WsCallback): void;
  9.     /**
  10.      * Listen and launch the service
  11.      */
  12.     listen(port: number, cb?: WsCallback): void;
  13.     /**
  14.      * Handle new requests
  15.      */
  16.     set onconnection(cb: (client: WebSocketServerConnection) => void);
  17.     /**
  18.      * Set up the server shutdown callback
  19.      */
  20.     set onclose(cb: WsCallback);
  21.     /**
  22.      * Gets all the connection objects
  23.      */
  24.     get connections(): WebSocketServerConnection[];
  25. }
  27. /**
  28.  * The client connection object in the server
  29.  */
  30. class WebSocketServerConnection {
  31.     /**
  32.      * Close the connection
  33.      */
  34.     close(code?: number, reason?: string): void;
  35.     /**
  36.      * Send the data
  37.      */
  38.     send(data: string|ArrayBuffer, cb?: WsCallback): void;
  40.     set ontext(cb: (data: string) => void);
  41.     set onbinary(cb: (data: ArrayBuffer) => void);
  42.     set onmessage(cb: (data: string|ArrayBuffer) => void);
  43.     set onconnect(cb: () => void;);
  44.     set onclose(cb: WsCallback);
  45.     set onerror(cb: WsCallback);
  47.     get readyState(): number;
  48. }
  50. interface WsCallback {
  51.     (err?: string): void;
  52. }

Note: After v3.7.0, ondata callback has been deprecated, please use onmessage to instead.

The interface design refers to the nodejs-websocket server.