快應(yīng)用 WebSocket

WebSocketFactory 

接口聲明

{ "name": "system.websocketfactory" }

導(dǎo)入模塊

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

接口定義

方法

websocketfactory.create(OBJECT)

創(chuàng)建 websocket 實(shí)例

參數(shù)：

返回值：

示例：

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

WebSocket 

概述

WebSocket 對(duì)象提供了用于創(chuàng)建和管理 WebSocket 連接，以及可以通過該連接發(fā)送和接收數(shù)據(jù)的 API。

方法

WebSocket.send(OBJECT)

向服務(wù)器發(fā)送數(shù)據(jù)

參數(shù)：

示例：

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

WebSocket.close(OBJECT)

關(guān)閉當(dāng)前連接

參數(shù)：

示例：

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

用于指定連接成功后的回調(diào)函數(shù)

參數(shù)：

示例：

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

WebSocket.onmessage

用于指定當(dāng)從服務(wù)器接受到信息時(shí)的回調(diào)函數(shù)

參數(shù)：

callback 參數(shù)：

示例：

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

WebSocket.onclose

用于指定連接關(guān)閉后的回調(diào)函數(shù)

參數(shù)：

callback 參數(shù)：

示例：

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

WebSocket.onerror

用于指定連接失敗后的回調(diào)函數(shù)

參數(shù)：

callback 參數(shù)：

示例：

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

后臺(tái)運(yùn)行限制

無限制。

后臺(tái)運(yùn)行詳細(xì)用法參見 后臺(tái)運(yùn)行腳本。