教程 其他 框架 组件 接口

WebSocketFactory 1020+

接口声明

{ "name": "system.websocketfactory" }

导入模块

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

接口定义

方法

websocketfactory.create(OBJECT)

创建 websocket 实例

参数:

参数名类型必填说明
urlString请求 url, 必须是 wss 或 ws 协议
headerObject请求头,header 中不能设置 Referer,User-Agent设置在1040版本开始支持
protocolsStringArray子协议组

返回值:

类型描述
WebSocket返回一个 WebSocket 对象,请参考 WebSocket 对象

示例:

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

WebSocket 1020+

概述

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

方法

WebSocket.send(OBJECT)

向服务器发送数据

参数:

参数名类型必填说明
dataString | ArrayBuffer 1030+发送的消息
successFunction成功回调
failFunction失败回调

示例:

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

WebSocket.close(OBJECT)

关闭当前连接

参数:

参数名类型必填说明
codeNumber关闭链接的状态号 ,默认 1000
reasonString关闭的原因
successFunction接口调用成功的回调函数
failFunction接口调用失败的回调函数

示例:

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

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

参数:

参数名类型必填说明
callbackFunction打开连接回调

示例:

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

WebSocket.onmessage

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

参数:

参数名类型必填说明
callbackFunction服务器返回消息事件回调

callback 参数:

参数名类型说明
dataString | ArrayBuffer 1030+监听器接收到的消息, 消息类型与发送类型一致

示例:

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

WebSocket.onclose

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

参数:

参数名类型必填说明
callbackFunction关闭连接事件回调。

callback 参数:

参数名类型说明
codeNumber服务器返回关闭的状态码。
reasonString服务器返回的关闭原因。
wasCleanBoolean是否正常关闭。

示例:

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

WebSocket.onerror

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

参数:

参数名类型必填说明
callbackFunction连接错误回调

callback 参数:

参数名类型说明
dataString监听器接收到的消息。

示例:

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

后台运行限制

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

条匹配 "" 的结果

    没有搜索到与 "" 相关的内容