WebSocketFactory 1020+

接口声明

{ "name": "system.websocketfactory" }

导入模块

import websocketfactory from '@system.websocketfactory' 或 const websocketfactory = require('@system.websocketfactory')

接口定义

方法

websocketfactory.create(OBJECT)

创建 websocket 实例

参数：

返回值：

示例：

ws = websocketfactory.create({
  url: 'ws://test:8088',
  header: {
    'content-type': 'application/json'
  },
  protocols: ['protocol']
})

WebSocket 1020+

概述

WebSocket 对象提供了用于创建和管理 WebSocket 连接，以及可以通过该连接发送和接收数据的 API。

方法

WebSocket.send(OBJECT)

向服务器发送数据

参数：

示例：

ws.send({
  data: 'send message',
  success: function() {
    console.log(`send success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

WebSocket.close(OBJECT)

关闭当前连接

参数：

示例：

ws.close({
  code: 1000,
  reason: 'close as normal',
  success: function() {
    console.log(`close success`)
  },
  fail: function(data, code) {
    console.log(`handling fail, code = ${code}`)
  }
})

属性

WebSocket.onopen

用于指定连接成功后的回调函数

参数：

示例：

ws.onopen = function() {
  console.log(`connect open`)
}

WebSocket.onmessage

用于指定当从服务器接受到信息时的回调函数

参数：

callback 参数：

示例：

ws.onmessage = function(data) {
  console.log(`message is ${data.data}`)
}

WebSocket.onclose

用于指定连接关闭后的回调函数

参数：

callback 参数：

示例：

ws.onclose = function(data) {
  console.log(
    `onclose:data.code = ${data.code}, data.reason = ${
      data.reason
    }, data.wasClean = ${data.wasClean}`
  )
}

WebSocket.onerror

用于指定连接失败后的回调函数

参数：

callback 参数：

示例：

ws.onerror = function(data) {
  console.log(`onerror data.data = ${data.data}`)
}

后台运行限制

无限制。
后台运行详细用法参见后台运行 脚本。