本节将详细介绍WebSocket API及其使用方法。

 属性

WebSocket有两个属性，分别是readyState和bufferedAmount，其中bufferedAmount是作为连接缓冲用的，而WebSocket服务的readyState一共有以下4种状态。

 CONNECTING（值为数字0）。表示正在连接，尚未连接成功，这里有一个网络通信的握手过程。

 

注意，任何一个连接开始的时候，其状态都必须是CONNECTING=0。如果ready-State一直是CONNECTING状态，就会报出INVALID_STATE_ERR异常。

 OPEN（值为数字1）。表示连接已经成功，可以通信了。这里的连接是长连接、持久连接。

 CLOSING（值为数字2）。表示连接准备被断开，握手将被取消。

 CLOSED（值为数字3）。表示连接已经断开，可以从服务器端断开，也可以从客户端断开。

 

URL

URL属性都是一样的，哪怕是访问同源网站（这里的URL地址必须是绝对地址）。例如：

var Socket = new WebSocket('ws://www.test.com/');

 

哪怕本身这个发起WebSocket连接的地址就是www.test.com，也必须以ws://www.test.com为连接目标，否则就是错误的。

 

以下三种形式都是错误的：

var Socket = new WebSocket('/');

var Socket = new WebSocket('C:\www.test.com');

var Socket = new WebSocket('http://www.test.com');

以下两种形式都是允许的、正确的：

var Socket = new WebSocket('ws://www.test.com/updates');

var Socket = new WebSocket('ws://www.test.com/updates:8080');

 

事件

具体的事件说明如下，其中send()方法基于成功的连接传送数据，其参数必须是字符串（string）格式。

 

事件句柄 事件类型 解释

onopen open 连接打开

onmessage message 用于接受从服务器传来的信息

onerror error 当出现连接中的各种错误时，用于容错处理和排查

onclose close 连接关闭或断开

send send 基于成功的连接传送数据

 

这里需要注意，bufferedAmount属性作为还没有发送到网络中的最后一个待执行的事件轮询任务，必须返回正在队列中的（准备发送出去的）基于UTF-8格式文本的字节数量。（这包括在当前任务的执行中发送的文本，不论客户端是否能够异步传输文本。）

如果连接是关闭的，这个属性的值将仅增加每次使用send方法带来的数字变化（一旦连接关闭，该数字不能被初始化为0）。

 

在下面这个简单的例子中，bufferedAmount属性用于确保能够保持在每50ms一次更新的频率（如果网络能保持这个速率），如果这个速率太快，那么采用其他能够有保证的速率也可以：

var Socket = new WebSocket('ws://www.test.com:12010/updates');

Socket.onopen = function(){

setInterval(function(){

if(Socket.bufferedAmount == 0)

Socket.send(getUpdateData());

}, 50);

};