WebSocket

WebSocket提供了用于创建和操作WebSocket对象的API，通过这些API可以创建连接、发送和接受数据。

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

试图连接的端口被屏蔽。

方法概述

属性

常量

Ready state constants

这些常量是readyState属性的取值，可以用来描述WebSocket连接的状态。

方法

close()

关闭WebSocket连接或停止正在进行的连接请求。如果连接的状态已经是CLOSED，这个方法不会有任何效果

void close(
  in optional unsigned short code,
  in optional DOMString reason
);

参数

code 可选

一个数字值表示关闭连接的状态号，表示连接被关闭的原因。如果这个参数没有被制定，默认的取值是1000 （表示正常连接关闭）。 请看CloseEvent页面的 list of status codes来看默认的取值。

reason 可选

一个可读的字符串，表示连接被关闭的原因。这个字符串必须是不长于123字节的UTF-8 文本（不是字符）。

可能抛出的异常

INVALID_ACCESS_ERR

选定了无效的code。

SYNTAX_ERR

reason 字符串太长或者含有unpaired surrogates。

注

在Gecko中，Gecko 8.0 (Firefox 8.0 / Thunderbird 8.0 / SeaMonkey 2.5)之间的版本的实现不支持任何参数。

send()

通过WebSocket连接向服务器发送数据。

void send(
  in DOMString data
);

void send(
  in ArrayBuffer data
);

void send(
  in Blob data
); 

参数

data

要发送到服务器的数据。

可能抛出的异常

INVALID_STATE_ERR

当前连接的状态不是OPEN。

SYNTAX_ERR

数据是一个包含unpaired surrogates的字符串。

注意

另见

• Writing WebSocket client applications
• HTML5: WebSockets

浏览器兼容性

Gecko 注

从Gecko 6.0开始，构造器含有前缀，你需要调用MozWebSocket():

var mySocket = new MozWebSocket("http://www.example.com/socketserver");

extensions 属性直到Gecko 8.0才被支持。