# 网络
# 发起请求
# request
基础库1.3.9开始支持,iOS版本2.1.23,Android版本2.1.38
request(Object object)
利用原生Api发起HTTP网络请求,执行后返回 RequestTask 对象。
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
url | string | 是 | 开发者服务器接口地址 | |
data | string/object/ArrayBuffer | 否 | 请求的参数 | |
header | Object | 否 | 设置请求的 header,header 中不能设置 Referer。content-type 默认为 application/json | |
method | string | GET | 否 | HTTP 请求方法 |
timeout | number | 否 | 超时时间,单位为毫秒 | |
dataType | string | json | 否 | 返回的数据格式 |
responseType | string | text | 否 | 响应的数据类型 |
enableProfile | boolean | true | 否 | 是否开启 profile,默认开启。开启后可在接口回调的 res.profile 中查看性能调试信息。(基础库 3.5.2,android & iOS 2.46.3版本支持) |
enableChunked | boolean | false | 否 | 开启 transfer-encoding chunked。(android & iOS 2.43.5版本支持) |
forceCellularNetwork | boolean | false | 否 | wifi下使用移动网络发送请求(仅安卓支持) |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.method 的合法值
值 | 说明 |
---|---|
OPTIONS | HTTP 请求 OPTIONS |
GET | HTTP 请求 GET |
HEAD | HTTP 请求 HEAD |
POST | HTTP 请求 POST |
PUT | HTTP 请求 PUT |
DELETE | HTTP 请求 DELETE |
TRACE | HTTP 请求 TRACE |
CONNECT | HTTP 请求 CONNECT |
object.dataType 的合法值
值 | 说明 |
---|---|
json | 返回的数据为 JSON,返回后会对返回的数据进行一次 JSON.parse |
其他 | 不对返回的内容进行 JSON.parse |
object.responseType 的合法值
值 | 说明 |
---|---|
text | 响应的数据为文本 |
arraybuffer | 响应的数据为 ArrayBuffer |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
data | string/object/ArrayBuffer | 开发者服务器返回的数据 |
statusCode | number | 开发者服务器返回的 HTTP 状态码 |
header | Object | 开发者服务器返回的 HTTP Response Header |
profile | Object | 网络请求过程中一些调试信息 |
profile
属性 | 类型 | 说明 |
---|---|---|
fetchStart | number | 组件准备好使用 HTTP 请求抓取资源的时间,这发生在检查本地缓存之前 |
domainLookUpStart | number | DNS 域名查询开始的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 |
domainLookUpEnd | number | DNS 域名查询完成的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 |
connectStart | number | HTTP(TCP) 开始建立连接的时间,如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接开始的时间 |
connectEnd | number | HTTP(TCP) 完成建立连接的时间(完成握手),如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接完成的时间。注意这里握手结束,包括安全连接建立完成、SOCKS 授权通过 |
SSLconnectionStart | number | SSL建立连接的时间,如果不是安全连接,则值为 0 |
SSLconnectionEnd | number | SSL建立完成的时间,如果不是安全连接,则值为 0 |
requestStart | number | HTTP请求读取真实文档开始的时间(完成建立连接),包括从本地读取缓存。连接错误重连时,这里显示的也是新建立连接的时间 |
requestEnd | number | HTTP请求读取真实文档结束的时间 |
responseStart | number | HTTP 开始接收响应的时间(获取到第一个字节),包括从本地读取缓存 |
responseEnd | number | HTTP 响应全部接收完成的时间(获取到最后一个字节),包括从本地读取缓存 |
rtt | number | 当次请求连接过程中实时 rtt |
estimate_nettype | number | 评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6 |
httpRttEstimate | number | 协议层根据多个请求评估当前网络的 rtt(仅供参考) |
transportRttEstimate | number | 传输层根据多个请求评估的当前网络的 rtt(仅供参考) |
downstreamThroughputKbpsEstimate | number | 评估当前网络下载的kbps |
peerIP | string | 当前请求的IP |
port | number | 当前请求的端口 |
socketReused | boolean | 是否复用连接 |
sendBytesCount | number | 发送的字节数 |
receivedBytedCount | number | 收到字节数 |
protocol | string | 使用协议类型,有效值:http/1.1, h2, quic, unknown |
示例代码
ft.request({
url: 'test.php', // 仅为示例,并非真实的接口地址
data: {
x: '',
y: ''
},
header: {
'content-type': 'application/json' // 默认值
},
success(res) {
console.log(res.data)
}
})
# RequestTask.abort
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
RequestTask.abort()
中断请求任务
示例代码
const task = ft.request({
// some params
})
// 中断请求
task.abort()
# RequestTask.onHeadersReceived
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
RequestTask.onHeadersReceived(function callback)
监听 HTTP Response Header 事件,会比请求完成事件更早。
参数
function callback
Header Received 事件的回调函数
回调函数参数
Object res
属性 | 类型 | 说明 |
---|---|---|
header | Object | 开发者服务器返回的 HTTP Response Header |
# RequestTask.offHeadersReceived
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
RequestTask.offHeadersReceived(function callback)
取消监听 HTTP Response Header 事件。
参数
function callback
Header Received 事件的回调函数
# RequestTask.onChunkReceived
基础库3.2.3开始支持,iOS版本2.43.7,Android版本2.43.7
RequestTask.onChunkReceived(function callback)
监听 Chunk Received 事件,当接收到新的 chunk 时触发
参数
function callback
Chunk Received 事件的回调函数
回调函数参数
Object res
属性 | 类型 | 说明 |
---|---|---|
data | ArrayBuffer | 请求返回的 chunk buffer |
# RequestTask.offChunkReceived
基础库3.2.3开始支持,iOS版本2.43.7,Android版本2.43.7
RequestTask.offChunkReceived(function callback)
取消监听 Chunk Received 事件
参数
function callback
Chunk Received 事件的回调函数
# 下载
# downloadFile
基础库1.3.9开始支持,iOS版本2.1.23,Android版本2.1.38
downloadFile(Object object)
下载文件资源到本地。客户端直接发起一个 HTTPS GET 请求,返回文件的本地临时路径。
调用后返回 DownloadTask。
注意
请在服务端响应的 header 中指定合理的 Content-Type 字段,以保证客户端正确处理文件类型。
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
url | string | 是 | 下载资源的 url | |
header | Object | 否 | 设置请求的 header,header 中不能设置 Referer | |
timeout | number | 否 | 超时时间,单位为毫秒 | |
filePath | string | 否 | 指定文件下载后存储的路径 (本地路径) | |
enableProfile | boolean | true | 否 | 是否开启 profile,默认开启。开启后可在接口回调的 res.profile 中查看性能调试信息。(基础库 3.5.2,android & iOS 2.46.3版本支持) |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
tempFilePath | string | 临时文件路径。 |
filePath | string | 用户文件路径 (本地路径)。传入 filePath 时会返回,跟传入的 filePath 一致 |
statusCode | number | 开发者服务器返回的 HTTP 状态码 |
profile | Object | 网络请求过程中一些调试信息 |
profile
属性 | 类型 | 说明 |
---|---|---|
fetchStart | number | 组件准备好使用 HTTP 请求抓取资源的时间,这发生在检查本地缓存之前 |
domainLookUpStart | number | DNS 域名查询开始的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 |
domainLookUpEnd | number | DNS 域名查询完成的时间,如果使用了本地缓存(即无 DNS 查询)或持久连接,则与 fetchStart 值相等 |
connectStart | number | HTTP(TCP) 开始建立连接的时间,如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接开始的时间 |
connectEnd | number | HTTP(TCP) 完成建立连接的时间(完成握手),如果是持久连接,则与 fetchStart 值相等。注意如果在传输层发生了错误且重新建立连接,则这里显示的是新建立的连接完成的时间。注意这里握手结束,包括安全连接建立完成、SOCKS 授权通过 |
SSLconnectionStart | number | SSL建立连接的时间,如果不是安全连接,则值为 0 |
SSLconnectionEnd | number | SSL建立完成的时间,如果不是安全连接,则值为 0 |
requestStart | number | HTTP请求读取真实文档开始的时间(完成建立连接),包括从本地读取缓存。连接错误重连时,这里显示的也是新建立连接的时间 |
requestEnd | number | HTTP请求读取真实文档结束的时间 |
responseStart | number | HTTP 开始接收响应的时间(获取到第一个字节),包括从本地读取缓存 |
responseEnd | number | HTTP 响应全部接收完成的时间(获取到最后一个字节),包括从本地读取缓存 |
rtt | number | 当次请求连接过程中实时 rtt |
estimate_nettype | number | 评估的网络状态 unknown, offline, slow 2g, 2g, 3g, 4g, last/0, 1, 2, 3, 4, 5, 6 |
httpRttEstimate | number | 协议层根据多个请求评估当前网络的 rtt(仅供参考) |
transportRttEstimate | number | 传输层根据多个请求评估的当前网络的 rtt(仅供参考) |
downstreamThroughputKbpsEstimate | number | 评估当前网络下载的kbps |
peerIP | string | 当前请求的IP |
port | number | 当前请求的端口 |
socketReused | boolean | 是否复用连接 |
sendBytesCount | number | 发送的字节数 |
receivedBytedCount | number | 收到字节数 |
protocol | string | 使用协议类型,有效值:http/1.1, h2, quic, unknown |
示例代码
ft.downloadFile({
url: 'https://example.com/audio/123', // 仅为示例,并非真实的资源
success(res) {
// 只要服务器有响应数据,就会把响应内容写入文件并进入 success 回调,业务需要自行判断是否下载到了想要的内容
if (res.statusCode === 200) {
ft.playVoice({
filePath: res.tempFilePath
})
}
}
})
# DownloadTask.abort
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
DownloadTask.abort()
中断请求任务
示例代码
const task = ft.request({
// some params
})
// 中断请求
task.abort()
# DownloadTask.onHeadersReceived
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
DownloadTask.onHeadersReceived(function callback)
监听 HTTP Response Header 事件,会比请求完成事件更早。
参数
function callback
Header Received 事件的回调函数
回调函数参数
Object res
属性 | 类型 | 说明 |
---|---|---|
header | Object | 开发者服务器返回的 HTTP Response Header |
# DownloadTask.offHeadersReceived
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
DownloadTask.offHeadersReceived(function callback)
取消监听 HTTP Response Header 事件。
参数
function callback
Header Received 事件的回调函数
# DownloadTask.onProgressUpdate
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
DownloadTask.onProgressUpdate(function callback)
监听下载进度变化事件。
参数
function callback
Progress Update 事件的回调函数
回调函数参数
Object res
属性 | 类型 | 说明 |
---|---|---|
progress | number | 下载进度百分比 |
totalBytesWritten | number | 已经下载的数据长度,单位 Bytes |
totalBytesExpectedToWrite | number | 预期需要下载的数据总长度,单位 Bytes |
示例代码
const task = ft.downloadFile({
// some params
})
// 监听进度变化
task.onProgressUpdate((res) => {
this.setData({
progress: res.progress
})
})
# DownloadTask.offProgressUpdate
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
DownloadTask.offProgressUpdate(function callback)
取消监听下载进度变化。
参数
function callback
Progress Update 事件的回调函数
# 上传
# uploadFile
基础库1.3.9开始支持,iOS版本2.1.23,Android版本2.1.38
uploadFile(Object object)
将本地资源上传到服务器。客户端发起一个 HTTPS POST 请求,其中 content-type 为multipart/form-data。
调用后返回 UploadTask。
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
url | string | 是 | 开发者服务器地址 | |
filePath | string | 是 | 要上传文件资源的路径 | |
name | string | 是 | 文件对应的 key,开发者在服务端可以通过这个 key 获取文件的二进制内容 | |
header | Object | 否 | 设置请求的 header,header 中不能设置 Referer | |
formData | Object | 否 | HTTP 请求中其他额外的 form data | |
timeout | number | 否 | 超时时间,单位为毫秒 | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
object.success 回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
data | string | 开发者服务器返回的数据 |
statusCode | number | 开发者服务器返回的 HTTP 状态码 |
示例代码
ft.chooseImage({
success(res) {
const tempFilePaths = res.tempFilePaths
ft.uploadFile({
url: 'https://example.weixin.qq.com/upload', // 仅为示例,非真实的接口地址
filePath: tempFilePaths[0],
name: 'file',
formData: {
user: 'test'
},
success(res) {
const data = res.data
// do something
}
})
}
})
# UploadTask.abort
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
UploadTask.abort()
中断请求任务
示例代码
const task = ft.request({
// some params
})
// 中断请求
task.abort()
# UploadTask.onHeadersReceived
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
UploadTask.onHeadersReceived(function callback)
监听 HTTP Response Header 事件,会比请求完成事件更早。
参数
function callback
Header Received 事件的回调函数
回调函数参数
Object res
属性 | 类型 | 说明 |
---|---|---|
header | Object | 开发者服务器返回的 HTTP Response Header |
# UploadTask.offHeadersReceived
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
UploadTask.offHeadersReceived(function callback)
取消监听 HTTP Response Header 事件。
参数
function callback
Header Received 事件的回调函数
# UploadTask.onProgressUpdate
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
UploadTask.onProgressUpdate(function callback)
监听下载进度变化事件。
参数
function callback
Progress Update 事件的回调函数
回调函数参数
Object res
属性 | 类型 | 说明 |
---|---|---|
progress | number | 上传进度百分比 |
totalBytesSent | number | 已经上传的数据长度,单位 Bytes |
totalBytesExpectedToSend | number | 预期需要上传的数据总长度,单位 Bytes |
示例代码
const task = ft.uploadFile({
// some params
})
// 监听进度变化
task.onProgressUpdate((res) => {
this.setData({
progress: res.progress
})
})
# UploadTask.offProgressUpdate
基础库2.4.2开始支持,iOS版本2.13.59,Android版本2.13.34
UploadTask.offProgressUpdate(function callback)
取消监听下载进度变化。
参数
function callbackProgress Update 事件的回调函数
# Websocket
# sendSocketMessage
ft.sendSocketMessage(Object object)
通过 WebSocket 连接发送数据。需要先 ft.connectSocket,并在 ft.onSocketOpen 回调之后才能发送。
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
data | string/ArrayBuffer | 是 | 需要发送的内容 | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码
let socketOpen = false
let socketMsgQueue = []
ft.connectSocket({
url: 'test.php'
})
ft.onSocketOpen(function(res) {
socketOpen = true
for (let i = 0; i < socketMsgQueue.length; i++){
sendSocketMessage(socketMsgQueue[i])
}
socketMsgQueue = []
})
function sendSocketMessage(msg) {
if (socketOpen) {
ft.sendSocketMessage({
data:msg
})
} else {
socketMsgQueue.push(msg)
}
}
# onSocketOpen
ft.onSocketOpen(function callback)
监听 WebSocket 连接打开事件
参数
function callback
WebSocket 连接打开事件的回调函数
参数
属性 | 类型 | 说明 |
---|---|---|
header | object | 连接成功的 HTTP 响应 Header |
# onSocketMessage
ft.onSocketMessage(function callback)
监听 WebSocket 接受到服务器的消息事件
参数
function callback
WebSocket 接受到服务器的消息事件的回调函数
参数
Object res
属性 | 类型 | 说明 |
---|---|---|
data | string/ArrayBuffer | 服务器返回的消息 |
# onSocketError
ft.onSocketError(function callback)
监听 WebSocket 错误事件
参数
function callback
WebSocket 错误事件的回调函数
参数
# Object res
属性 | 类型 | 说明 |
---|---|---|
errMsg | string | 错误信息 |
# onSocketClose
ft.onSocketClose(function callback)
监听 WebSocket 连接关闭事件
参数
function callback
WebSocket 连接关闭事件的回调函数
参数
# Object res
属性 | 类型 | 说明 |
---|---|---|
code | number | 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 |
reason | string | 一个可读的字符串,表示连接被关闭的原因。 |
# connectSocket
SocketTask ft.connectSocket(Object object)
创建一个 WebSocket 连接。使用前请注意阅读相关说明。
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 |
---|---|---|---|---|---|
url | string | 是 | 开发者服务器 wss 接口地址 | ||
header | Object | 否 | HTTP Header,Header 中不能设置 Referer | ||
protocols | Array.<string> | 否 | 子协议数组 | 1.4.0 | |
tcpNoDelay | boolean | false | 否 | 建立 TCP 连接的时候的 TCP_NODELAY 设置 | 2.4.0 |
perMessageDeflate | boolean | false | 否 | 是否开启压缩扩展 | 2.8.0 |
timeout | number | 否 | 超时时间,单位为毫秒 | 2.10.0 | |
success | function | 否 | 接口调用成功的回调函数 | ||
fail | function | 否 | 接口调用失败的回调函数 | ||
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
返回值
SocketTask
WebSocket 任务
示例代码
ft.connectSocket({
url: 'wss://example.qq.com',
header:{
'content-type': 'application/json'
},
protocols: ['protocol1']
})
# closeSocket
ft.closeSocket(Object object)
关闭 WebSocket 连接
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
code | number | 1000(表示正常关闭连接) | 否 | 一个数字值表示关闭连接的状态号,表示连接被关闭的原因。 |
reason | string | 否 | 一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。 | |
success | function | 否 | 接口调用成功的回调函数 | |
fail | function | 否 | 接口调用失败的回调函数 | |
complete | function | 否 | 接口调用结束的回调函数(调用成功、失败都会执行) |
示例代码
ft.connectSocket({
url: 'test.php'
})
//注意这里有时序问题,
//如果 ft.connectSocket 还没回调 ft.onSocketOpen,而先调用 ft.closeSocket,那么就做不到关闭 WebSocket 的目的。
//必须在 WebSocket 打开期间调用 ft.closeSocket 才能关闭。
ft.onSocketOpen(function() {
ft.closeSocket()
})
ft.onSocketClose(function(res) {
console.log('WebSocket 已关闭!')
})
# SocketTask
WebSocket 任务,可通过 ft.connectSocket() 接口创建返回
方法
SocketTask.send(Object object)
通过 WebSocket 连接发送数据SocketTask.close(Object object)
关闭 WebSocket 连接SocketTask.onOpen(function callback)
监听 WebSocket 连接打开事件SocketTask.onClose(function callback)
监听 WebSocket 连接关闭事件SocketTask.onError(function callback)
监听 WebSocket 错误事件SocketTask.onMessage(function callback)
监听 WebSocket 接受到服务器的消息事件
# TCP 通信
# ft.createTCPSocket
ft.createTCPSocket()
创建一个 TCP Socket 实例
返回值
TCPSocket
一个 TCP Socket 实例
连接限制
- 允许与局域网内的非本机 IP 通信
- 禁止与以下端口号连接:
1024 以下
1099
1433
1521
1719
1720
1723
2049
2375
3128
3306
3389
3659
4045
5060
5061
5432
5984
6379
6000
6566
7001
7002
8000-8100
8443
8888
9200
9300
10051
10080
11211
27017
27018
27019
- 每 5 分钟内最多创建 20 个 TCPSocket
# TCPSocket
一个 TCP Socket 实例,默认使用 IPv4 协议
# TCPSocket.connect
TCPSocket.connect(Object options)
在给定的套接字上启动连接
参数
Object options
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
address | string | 是 | 套接字要连接的地址 | |
port | number | 是 | 套接字要连接的端口 | |
timeout | number | 2 | 否 | 套接字要连接的超时时间,默认为 2s |
示例代码
const tcp = ft.createTCPSocket()
tcp.connect({
address: '192.168.114.514',
port: 8080
})
# TCPSocket.write
TCPSocket.write(string|ArrayBuffer data)
在 socket 上发送数据
参数
string|ArrayBuffer data
要发送的数据,可以是 string 或 ArrayBuffer
示例代码
const tcp = ft.createTCPSocket()
tcp.write('Hello FinClip.')
# TCPSocket.close
TCPSocket.close()
关闭连接
示例代码
const tcp = ft.createTCPSocket()
tcp.close()
# TCPSocket.onClose
TCPSocket.onClose(function callback)
监听事件,socket 完全关闭时触发
参数
function callback
监听函数
示例代码
const tcp = ft.createTCPSocket()
const callback = () => {
console.log('close')
}
tcp.onClose(callback)
# TCPSocket.offClose
TCPSocket.offClose(function callback)
取消监听 socket 完全关闭时的事件
参数
function callback
监听函数
示例代码
const tcp = ft.createTCPSocket()
const callback = () => {
console.log('close')
}
tcp.offClose(callback)
# TCPSocket.onConnect
TCPSocket.onConnect(function callback)
监听事件,socket 连接成功建立时触发
参数
function callback
监听函数
示例代码
const tcp = ft.createTCPSocket()
const callback = () => {
console.log('connect')
}
tcp.onConnect(callback)
# TCPSocket.offConnect
TCPSocket.offConnect(function callback)
取消监听 socket 连接成功建立时的事件
参数
function callback
监听函数
示例代码
const tcp = ft.createTCPSocket()
const callback = () => {
console.log('connect')
}
tcp.offConnect(callback)
# TCPSocket.onError
TCPSocket.onError(function callback)
监听事件,当 socket 发生错误时触发
参数
function callback
监听函数
示例代码
const tcp = ft.createTCPSocket()
const callback = () => {
console.log('error')
}
tcp.onError(callback)
# TCPSocket.offError
TCPSocket.offError(function callback)
取消监听当 socket 发生错误时触发的事件
参数
function callback
监听函数
示例代码
const tcp = ft.createTCPSocket()
const callback = () => {
console.log('error')
}
tcp.offError(callback)
# TCPSocket.onMessage
TCPSocket.onMessage(function callback)
监听事件,当 socket 接收到数据时触发
参数
function callback
监听函数
示例代码
const tcp = ft.createTCPSocket()
const callback = (res) => {
console.log('message', res)
}
tcp.onMessage(callback)
# TCPSocket.offMessage
TCPSocket.offMessage(function callback)
取消监听当 socket 接收到数据时触发的事件
参数
function callback
监听函数
示例代码
const tcp = ft.createTCPSocket()
const callback = (res) => {
console.log('message', res)
}
tcp.offMessage(callback)
错误
错误码 | 说明 |
---|---|
-1 | 系统错误 |
-2 | socket接口错误,可参考系统的socket错误码 |
-3 | 发送失败,无接口权限 |
-4 | 链接失败 |
1 | 发送失败,参数错误,address不合法 |
2 | 发送失败,参数错误,port不合法 |
# UDP 通信
# ft.createUDPSocket
ft.createUDPSocket() 创建一个 UDP Socket 实例
返回值
UDPSocket
一个 UDP Socket 实例
# UDPSocket
一个 UDP Socket 实例,默认使用 IPv4 协议。
方法
number UDPSocket.bind(number port)
绑定一个系统随机分配的可用端口,或绑定一个指定的端口号
UDPSocket.setTTL(number ttl)
设置 IP_TTL 套接字选项,用于设置一个 IP 数据包传输时允许的最大跳步数
UDPSocket.send(Object object)
向指定的 IP 和 port 发送消息
参数
Object object
属性 | 类型 | 默认值 | 必填 | 说明 |
---|---|---|---|---|
address | string | 是 | 要发消息的地址 | |
port | number | 是 | 要发送消息的端口号 | |
message | string/ArrayBuffer | 是 | 要发送的数据 | |
offset | number | 0 | 否 | 发送数据的偏移量,仅当 message 为 ArrayBuffer 类型时有效 |
length | number | message.byteLength | 否 | 发送数据的长度,仅当 message 为 ArrayBuffer 类型时有效 |
setBroadcast | boolean | false | 否 | 向指定地址发消息时,是否要开启广播,未支持 |
UDPSocket.connect(Object object)
预先连接到指定的 IP 和 port,需要配合 write 方法一起使用
UDPSocket.write()
用法与 send 方法相同,如果没有预先调用 connect 则与 send 无差异(注意即使调用了 connect 也需要在本接口填入地址和端口参数)
UDPSocket.close()
关闭 UDP Socket 实例,相当于销毁。
在关闭之后,UDP Socket 实例不能再发送消息,每次调用 UDPSocket.send 将会触发错误事件,并且 message 事件回调函数也不会再也执行。在 UDPSocket 实例被创建后将被 Native 强引用,保证其不被 GC。在 UDPSocket.close 后将解除对其的强引用,让 UDPSocket 实例遵从 GC。
UDPSocket.onClose(function callback)
监听关闭事件
UDPSocket.offClose(function callback)
取消监听关闭事件
UDPSocket.onError(function callback)
监听错误事件
UDPSocket.offError(function callback)
取消监听错误事件
UDPSocket.onListening(function callback)
监听开始监听数据包消息的事件
UDPSocket.offListening(function callback)
取消监听开始监听数据包消息的事件
UDPSocket.onMessage(function callback)
监听收到消息的事件
UDPSocket.offMessage(function callback)
取消监听收到消息的事件
错误
错误码 | 错误信息 | 说明 |
---|---|---|
-1 | 系统错误 | |
-2 | socket接口错误 | |
-3 | 发送失败,无接口权限 | |
1 | 发送失败,参数错误,address不合法 | |
2 | 发送失败,参数错误,port不合法 |