Laya WebSocket

  • WebSocket 是基于 TCP 的协议,使Html5可以实现进行全双工通讯的协议。websocket 常见于浏览器中,但是这个协议不受使用平台的限制。
  • Laya的Laya.Socket是对Html5 WebScoket的封装。发送的数据格式一般为字符串或者二进制。
  • 通信数据格式是二进制数据,则需要配合Laya.Byte使用,二进制格式的优点和使用方法可以看下Laya Byte。
  • webSocket的链接是异步过程。所以通信消息都需要在open事件完成之后操作。
    webScoket事件:
    Event Summary
    open 连接建立成功后调度。
    message 接收到数据后调度。
    close 连接被关闭后调度。
    error 出现异常后调度。

关于webSocket我们不做其他赘述,有兴趣可以看下HTML5 WebSocket。

Laya.Scoket

  • Property(属性)
Name Summary
connected 表示此 Socket 对象目前是否已连接。
disableInput 不再缓存服务端发来的数据。
endian 主机字节序,是 CPU 存放数据的两种不同顺序,包括小端字节序和大端字节序。
input 缓存的服务端发来的数据。
output 表示需要发送至服务端的缓冲区中的数据。
protocols 子协议名称。子协议名称字符串,或由多个子协议名称字符串构成的数组。
  • Method(方法)
Name Summary
Socket 创建新的 Socket 对象。默认字节序为 Socket.BIG_ENDIAN 。
cleanSocket 清理socket。
close 关闭连接。
connect 连接到指定的主机和端口。
connectByUrl 连接到指定的服务端 WebSocket URL。
flush 发送缓冲区中的数据到服务器。
send 发送数据到服务器。
  • Constants(常量)
    • BIG_ENDIAN
      主机字节序,是 CPU 存放数据的两种不同顺序,包括小端字节序和大端字节序。 BIG_ENDIAN :大端字节序,地址低位存储值的高位,地址高位存储值的低位。有时也称之为网络字节序。 LITTLE_ENDIAN :小端字节序,地址低位存储值的低位,地址高位存储值的高位。
    • LITTLE_ENDIAN
      主机字节序,是 CPU 存放数据的两种不同顺序,包括小端字节序和大端字节序。 LITTLE_ENDIAN :小端字节序,地址低位存储值的低位,地址高位存储值的高位。 BIG_ENDIAN :大端字节序,地址低位存储值的高位,地址高位存储值的低位。有时也称之为网络字节序。

Laya.Socket使用

  • 服务端

    • 使用pywebsocket搭建简易web服务

    • 可以使用网上的webScoket在线测试工具。比如wss://ws2s.feling.net/

  • 客户端

private webSocket: Laya.Socket;
    private openBtn: Laya.Button;
    private sendBtn: Laya.Button;
    private closeBtn: Laya.Button;
    initWebSocket() {
        this.openBtn = new Laya.Button(null, '连接服务器');
        this.openBtn.width = 150,
            this.openBtn.height = 50
        this.openBtn.labelSize = 30;
        this.openBtn.labelColors = '#FFFFFF';
        this.openBtn.x = 200;
        this.openBtn.y = 150;
        Laya.stage.addChild(this.openBtn);

        this.sendBtn = new Laya.Button(null, '发送消息');
        this.sendBtn.width = 150,
            this.sendBtn.height = 50
        this.sendBtn.labelSize = 30;
        this.sendBtn.labelColors = '#FFFFFF';
        this.sendBtn.x = 200;
        this.sendBtn.y = 350;
        Laya.stage.addChild(this.sendBtn);

        this.closeBtn = new Laya.Button(null, '断开服务器');
        this.closeBtn.width = 150,
            this.closeBtn.height = 50
        this.closeBtn.labelSize = 30;
        this.closeBtn.labelColors = '#FFFFFF';
        this.closeBtn.x = 200;
        this.closeBtn.y = 550;
        Laya.stage.addChild(this.closeBtn);

        //初始化Socket对象
        this.webSocket = new Laya.Socket();
        this.webSocket.on(Laya.Event.OPEN, this, this.openHandler);//连接正常打开抛出的事件
        this.webSocket.on(Laya.Event.MESSAGE, this, this.receiveMsgHandler);//接收到消息抛出的事件
        this.webSocket.on(Laya.Event.CLOSE, this, this.closeHandler);//socket关闭抛出的事件
        this.webSocket.on(Laya.Event.ERROR, this, this.errorHandler);//连接出错抛出的事件

        //点击按钮链接服务器
        this.openBtn.on(Laya.Event.CLICK, this, () => {
            this.webSocket.connectByUrl("wss://ws2s.feling.net/");
        })
        //点击按钮发送消息
        this.sendBtn.on(Laya.Event.CLICK, this, () => {
            this.webSocket.send('{"command":"connect","host":"ip.feling.net","port":80}');
        })
        //点击按钮断开链接
        this.closeBtn.on(Laya.Event.CLICK, this, () => {
            this.webSocket.close();
        })

    }

    openHandler(msg) {
        console.log("webSocket链接成功,可以发送消息.");
    }

    receiveMsgHandler(msg) {
        console.log("收到服务器消息: " + JSON.stringify(msg));
    }

    closeHandler(msg) {
        console.log("与服务器连接断开.");
    }

    errorHandler(msg) {
        console.log("与服务器通信错误.");
    }

大致通信流程:
客户端发起链接—>链接成功响应OPEN事件
客户端发送消息—>服务端接受到消息处理完后进行回调—>客户端响应MESSAGE事件
客户端断开链接—>断开链接响应Close事件

你可能感兴趣的:(Laya WebSocket)