返回介绍

webSocket

发布于 2020-01-01 14:27:54 字数 4217 浏览 2398 评论 0 收藏 0

webSockets 是一种创建持久性的连接,并进行双向数据传输的 HTTP 通信协议。Weex 提供了 webSockets 模块方便用户在 H5/iOS/Android 环境下与服务端创建 webSockets 链接进行通信。

注意

h5 提供 WebSockets 的 protocol 默认实现,iOS 和 Android 需要自定义实现,Android 可参考:

WebSocket

创建 WebSockets,并连接服务器。

WebSocket(url, protocol)

  • @url, string, 表示要连接的 URL
  • @protocol, string, WebSockets 协议名字字符串
const ws = weex.requireModule('webSocket');
ws.WebSocket('ws://echo.websocket.org','');

send

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

send(data)

  • @data, string, 要发送到服务器的数据
const ws = weex.requireModule('webSocket');
ws.WebSocket('ws://echo.websocket.org','');
ws.send('some message.');

close

关闭 WebSockets 的链接。

close(code, reason)

  • @code, number, 关闭连接的状态号
  • @reason, string, 关闭的原因
const ws = weex.requireModule('webSocket');
ws.WebSocket('ws://echo.websocket.org','');
ws.close();

onopen

一个用于连接打开事件的事件监听器,该事件表明这个连接已经准备好接受和发送数据。onopen 接受一个函数作为 EventListener,这个监听器会接受一个 type 为 "open" 的事件对象。

onopen(options)

标准 event 对象,无特殊属性。

const ws = weex.requireModule('webSocket')
ws.WebSocket('ws://echo.websocket.org','');
ws.onopen(function(event) {
  console.log('onopen', event);
});

onmessage

一个用于消息事件的事件监听器,当有消息到达的时触发。onmessage 接受一个函数作为 EventListener,这个监听器会接受一个 type 为 "message" 的事件对象。

onmessage(options)

  • @options, object.
    • data, string, 监听器接收的到的消息
const ws = weex.requireModule('webSocket')
ws.WebSocket('ws://echo.websocket.org','');
ws.onmessage(function(event) {
  console.log('onmessage', event);
});

onclose

一个用于连接关闭事件的事件监听器,当连接关闭时触发。onclose 接受一个函数作为 EventListener,这个监听器会接受一个 type 为 "close" 的事件对象。

onclose(options)

  • @options, object
    • code, number, 服务器返回关闭的状态码
    • reason, string, 服务器返回的关闭原因
    • wasClean, boolen, 是否完全关闭
const ws = weex.requireModule('webSocket')
ws.WebSocket('ws://echo.websocket.org','');
ws.onclose(function(event) {
  console.log('onclose', event);
});

onerror

一个用于 error 事件的事件监听器,当错误发生时触发。onerror 接受一个函数作为 EventListener,这个监听器会接受一个 type 为 "error" 的事件对象。

onerror(options)

  • @options, object
    • data, string, 监听器接收的到的消息
const ws = weex.requireModule('webSocket')
ws.WebSocket('ws://echo.websocket.org','');
ws.onerror(function(event) {
  console.log('onerror', event);
});

Demos

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。
列表为空,暂无数据
    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文