Appearance

目录

WebSocket ​

WebSocket组件，提供长链接功能。

属性 ​

属性名类型说明
onopencallback: () => void链接连上时的回调
onmessagecallback: (event: MessageEvent) => void接收消息的回调
onclosecallback: (event: CloseEvent) => void链接关闭时的回调
onerrorcallback: () => void链接出错时的回调

方法 ​

js
/**
 * 连接WebSocket（构造方法）
 *
 * @param url 链接地址
 */
WebSocket(url: string);
js
/**
 * 关闭WebSocket
 */
close();
js
/**
 * 发送消息
 *
 * @param data 消息
 */
send(data: string);

MessageEvent ​

属性名类型说明
datastring消息文本

CloseEvent ​

属性名类型说明
codenumber错误码
reasonstring错误原因描述

Close码 ​

codeReason
1000CLOSE_NORMAL
1001CLOSE_GOING_AWAY
1002CLOSE_PROTOCOL_ERROR
1003CLOSE_UNSUPPORTED
1005CLOSE_NO_STATUS
1006CLOSE_ABNORMAL
1007UNSUPPORTED_DATA
1008POLICY_VIOLATION
1009CLOSE_TOO_LARGE
1010MISSING_EXTENSION
1011INTERNAL_ERROR
1012SERVICE_RESTART
1013TRY_AGAIN_LATER
1015TLS_HANDSHAKE

INFO

详细请参考：https://developer.mozilla.org/en-US/docs/Web/API/CloseEvent

示例 ​

js
// 建立连接
let ws = new WebSocket('ws://x.x.x.x:8000');

// 设置各种监听回调
ws.onopen = () => {
    console.log('WebSocket onOpen');
};
ws.onmessage = (event) => {
    console.log('WebSocket onMessage, event.data = ' + event.data);
};
ws.onclose = (event) => {
    console.log('WebSocket onClose, event.code = ' + event.code + ', event.reason = ' + event.reason);
};
ws.onerror = () => {
    console.log('WebSocket onError');
};

// 关闭连接
ws.close();

// 发送消息
ws.send('test message!');