Egret Engine R - v6.0.0
    Preparing search index...

    Class WebSocket

    egret.WebSocket 类启用代码以建立传输控制协议 (TCP) 套接字连接，用于发送和接收字符串或二进制数据。 要使用 egret.WebSocket 类的方法，请先使用构造函数 new egret.WebSocket 创建一个 egret.WebSocket 对象。 套接字以异步方式传输和接收数据。 Event.CONNECT 连接服务器成功。 ProgressEvent.SOCKET_DATA 接收服务器数据。 Event.CLOSE 在服务器关闭连接时调度。 IOErrorEvent.IO_ERROR 在出现输入/输出错误并导致发送或加载操作失败时调度。。

    http://edn.egret.com/cn/docs/page/602 WebSocket

    Egret 2.4

    Web

    extension/socket/WebSocket.ts

    zh_CN

    Hierarchy

    • EventDispatcher
      • WebSocket
    Index
    constructor
    TYPE_STRING TYPE_BINARY URI
    connected type
    connect connectByUrl close flush writeUTF readUTF writeBytes readBytes

    • 创建一个 egret.WebSocket 对象 参数为预留参数，现版本暂不处理，连接地址和端口号在 connect 函数中传入

      Parameters

      • host: string = ""
      • port: number = 0

      Returns WebSocket

      Egret 2.4

      Web

      zh_CN

    TYPE_STRING: string = "webSocketTypeString"

    以字符串格式发送和接收数据

    Egret 2.4

    Web

    zh_CN

    TYPE_BINARY: string = "webSocketTypeBinary"

    以二进制格式发送和接收数据

    Egret 2.4

    Web

    zh_CN

    URI: "ws://" | "wss://" = "ws://"
    • get connected(): boolean

      表示此 Socket 对象目前是否已连接

      Returns boolean

      Egret 2.4

      Web

      zh_CN

    • 将套接字连接到指定的主机和端口

      Parameters

      • host: string

        要连接到的主机的名称或 IP 地址

      • port: number

        要连接到的端口号

      Returns void

      Egret 2.4

      Web

      zh_CN

    • 根据提供的url连接

      Parameters

      • url: string

        全地址。如ws://echo.websocket.org:80

      Returns void

    • 对套接字输出缓冲区中积累的所有数据进行刷新

      Returns void

      Egret 2.4

      Web

      zh_CN

    • 将字符串数据写入套接字

      Parameters

      • message: string

        要写入套接字的字符串

      Returns void

      Egret 2.4

      Web

      zh_CN

    • 从指定的字节数组写入一系列字节。写入操作从 offset 指定的位置开始。 如果省略了 length 参数，则默认长度 0 将导致该方法从 offset 开始写入整个缓冲区。 如果还省略了 offset 参数，则写入整个缓冲区。

      Parameters

      • bytes: ByteArray

        要从中读取数据的 ByteArray 对象

      • offset: number = 0

        ByteArray 对象中从零开始的偏移量，应由此开始执行数据写入

      • length: number = 0

        要写入的字节数。默认值 0 导致从 offset 参数指定的值开始写入整个缓冲区

      Returns void

      Egret 2.4

      Web

      zh_CN

    • 从套接字读取 length 参数指定的数据字节数。从 offset 所表示的位置开始，将这些字节读入指定的字节数组

      Parameters

      • bytes: ByteArray

        要将数据读入的 ByteArray 对象

      • offset: number = 0

        数据读取的偏移量应从该字节数组中开始

      • length: number = 0

        要读取的字节数。默认值 0 导致读取所有可用的数据

      Returns void

      Egret 2.4

      Web

      zh_CN

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods