WebSocket
WebSocket
对象提供了用于创建和管理 WebSocket 连接,以及可以通过该连接发送和接收数据的 API。
使用 WebSocket()
构造函数来构造一个 WebSocket
。
构造函数
WebSocket()
返回一个 WebSocket
对象。
常量
WebSocket.CONNECTING
WebSocket.OPEN
WebSocket.CLOSING
WebSocket.CLOSED
Constant | Value |
---|---|
WebSocket.CONNECTING | 0 |
WebSocket.OPEN | 1 |
WebSocket.CLOSING | 2 |
WebSocket.CLOSED | 3 |
属性
binaryType
使用二进制的数据类型连接。
bufferedAmount
未发送至服务器的字节数。
extensions
服务器选择的扩展。
onclose
用于指定连接关闭后的回调函数。
onerror
用于指定连接失败后的回调函数。
onmessage
用于指定当从服务器接受到信息时的回调函数。
onopen
用于指定连接成功后的回调函数。
protocol
服务器选择的下属协议。
readyState
当前的链接状态。
url
WebSocket 的绝对路径。
方法
WebSocket.close([code[, reason]])
关闭当前链接。
对要传输的数据进行排队。
事件
添加事件的两种方法
web socket对象添加addEventListener()
给on[eventname]赋值回调函数
使用 addEventListener()
或将一个事件监听器赋值给本接口的 oneventname
属性,来监听下面的事件。
事件类型
close
当一个 WebSocket
连接被关闭时触发。 也可以通过 onclose
属性来设置。
error
当一个 WebSocket
连接因错误而关闭时触发,例如无法发送数据时。 也可以通过 onerror
属性来设置。
message
当通过 WebSocket
收到数据时触发。 也可以通过 onmessage
属性来设置。
open
当一个 WebSocket
连接成功时触发。 也可以通过 onopen
属性来设置。
示例
// Create WebSocket connection.
const socket = new WebSocket('ws://localhost:8080');
// Connection opened
socket.addEventListener('open', function (event) {
socket.send('Hello Server!');
});
// Listen for messages
socket.addEventListener('message', function (event) {
console.log('Message from server ', event.data);
});
t