WebSocket

WebSocket 对象提供了一组用于创建和管理 WebSocket 连接，以及可以通过该连接发送和接收数据的 API。

 

WebSocket()

继承层次

Object.prototype
　Function.prototype
　　EventTarget
　　　WebSocket

构造函数

语法

WebSocket WebSocket(in DOMString url, in optional DOMString protocols);
WebSocket WebSocket(in DOMString url,in optional DOMString[] protocols);

参数

  • url
    表示要连接的URL。这个URL应该为响应WebSocket的地址。
  • protocols
    可选 , 可以是一个单个的协议名字字符串或者包含多个协议名字字符串的数组。这些字符串用来表示子协议，这样做可以让一个服务器实现多种WebSocket子协议（例如你可能希望通过制定不同的协议来处理不同类型的交互）。如果没有制定这个参数，它会默认设为一个空字符串。

构造器方法可能抛出以下异常：

  • SECURITY_ERR
    试图连接的端口被屏蔽。

属性列表

属性说明
--

方法列表

语法说明
--

WebSocket.prototype

继承层次

Object.prototype
　EventTarget.prototype
　　WebSocket.prototype

属性列表

属性说明
binaryType一个字符串表示被传输二进制的内容的类型。取值应当是“blob”或者“arraybuffer”。
“blob”表示使用 DOMBlob 对象，而“arraybuffer”表示使用 ArrayBuffer 对象。
bufferedAmount只读，调用 send() 方法加入到队列中等待传输，但是还没有发出的字节数。该值会在所有队列数据被发送后重置为 0。而当连接关闭时不会设为0。如果持续调用 send()，这个值会持续增长。
extensions服务器选定的扩展。目前这个属性只是一个空字符串，或者是一个包含所有扩展的列表。
onclose用于监听连接关闭事件监听器。当 WebSocket 对象的 readyState 状态变为 CLOSED 时会触发该事件。这个监听器会接收一个叫 close 的 CloseEvent对象。
onerror当错误发生时用于监听 error 事件的事件监听器。会接受一个名为 error 的 event 对象。
onmessage一个用于消息事件的事件监听器，这一事件当有消息到达的时候该事件会触发。这个 Listener 会被传入一个名为“message”的 MessageEvent 对象。
onopen一个用于连接打开事件的事件监听器。当 readyState 的值变为 OPEN 的时候会触发该事件。该事件表明这个连接已经准备好接受和发送数据。这个监听器会接受一个名为 “open” 的事件对象。
protocol一个表明服务器选定的子协议名字的字符串。这个属性的取值会被取值为构造器传入的 protocols 参数。
readyState只读，连接的当前状态。取值是 Ready state constants 之一。
url只读，传入构造器的 URL。它必须是一个绝对地址的 URL。

常量列表

常量说明
CONNECTING值为0，连接还没开启。
OPEN值为1，连接已开启并准备好进行通信。
CLOSING值为2，连接正在关闭的过程中。
CLOSED值为3，连接已经关闭，或者连接无法建立。

方法列表

语法说明
close()关闭 WebSocket 连接或停止正在进行的连接请求。如果连接的状态已经是 closed，这个方法不会有任何效果。
send()通过 WebSocket 连接向服务器发送数据。

WebSocket实例

Object.prototype
　EventTarget.prototype
　　WebSocket.prototype
　　　WebSocket 实例

参考

相关页面

外部链接


跳至内容顶部