Skip to content

D
Docs

OpenHarmony / Docs
大约 2 年 前同步成功

通知 161
Star 293
Fork 28
D
Docs
“8a6dc55cc32bd7c6344bb8a8b1ece319033e3319”上不存在“...sun/font/git@gitcode.net:openanolis/dragonwell8_jdk.git”
未验证 提交 65460701 编写于 作者: O openharmony_ci 提交者： Gitee
浏览文件
操作

!15595 Update http-request.md 

Merge pull request !15595 from Yangys/master
上级 ae1a267c 9a631800
隐藏空白更改
内联 并排
Showing with 210 addition and 206 deletion
zh-cn/application-dev/connectivity/http-request.md
浏览文件 @ 65460701
...@@ -30,7 +30,7 @@ HTTP数据请求功能主要由http模块提供。 ...@@ -30,7 +30,7 @@ HTTP数据请求功能主要由http模块提供。
| on\('dataProgress'\)<sup>10+</sup> | 订阅HTTP流式响应数据接收进度事件。 | | on\('dataProgress'\)<sup>10+</sup> | 订阅HTTP流式响应数据接收进度事件。 |
| off\('dataProgress'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收进度事件。 | | off\('dataProgress'\)<sup>10+</sup> | 取消订阅HTTP流式响应数据接收进度事件。 |
## 开发步骤 ## request接口开发步骤
1. 从@ohos.net.http.d.ts中导入http命名空间。 1. 从@ohos.net.http.d.ts中导入http命名空间。
2. 调用createHttp()方法，创建一个HttpRequest对象。 2. 调用createHttp()方法，创建一个HttpRequest对象。
...@@ -83,7 +83,7 @@ httpRequest.request( ...@@ -83,7 +83,7 @@ httpRequest.request(
console.info('error:' + JSON.stringify(err)); console.info('error:' + JSON.stringify(err));
// 取消订阅HTTP响应头事件 // 取消订阅HTTP响应头事件
httpRequest.off('headersReceive'); httpRequest.off('headersReceive');
// 当该请求使用完毕时，调用destroy方法主动销毁。 // 当该请求使用完毕时，调用destroy方法主动销毁
httpRequest.destroy(); httpRequest.destroy();
} }
} }
......
zh-cn/application-dev/connectivity/socket-connection.md
浏览文件 @ 65460701
...@@ -49,6 +49,7 @@ TLS Socket连接主要由tls_socket模块提供。具体接口说明如下表。 ...@@ -49,6 +49,7 @@ TLS Socket连接主要由tls_socket模块提供。具体接口说明如下表。
| 接口名 | 功能描述 | | 接口名 | 功能描述 |
| -------- | -------- | | -------- | -------- |
| constructTLSSocketInstance() | 创建一个TLSSocket对象。 |
| bind() | 绑定IP地址和端口号。 | | bind() | 绑定IP地址和端口号。 |
| close(type:&nbsp;'error') | 关闭连接。 | | close(type:&nbsp;'error') | 关闭连接。 |
| connect() | 连接到指定的IP地址和端口。 | | connect() | 连接到指定的IP地址和端口。 |
......
zh-cn/application-dev/reference/apis/js-apis-http.md
浏览文件 @ 65460701
...@@ -67,7 +67,7 @@ httpRequest.request( ...@@ -67,7 +67,7 @@ httpRequest.request(
## http.createHttp ## http.createHttp
createHttp\(\): HttpRequest createHttp(): HttpRequest
创建一个HTTP请求，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header事件。每一个HttpRequest对象对应一个HTTP请求。如需发起多个HTTP请求，须为每个HTTP请求创建对应HttpRequest对象。 创建一个HTTP请求，里面包括发起请求、中断请求、订阅/取消订阅HTTP Response Header事件。每一个HttpRequest对象对应一个HTTP请求。如需发起多个HTTP请求，须为每个HTTP请求创建对应HttpRequest对象。
...@@ -88,11 +88,11 @@ let httpRequest = http.createHttp(); ...@@ -88,11 +88,11 @@ let httpRequest = http.createHttp();
## HttpRequest ## HttpRequest
HTTP请求任务。在调用HttpRequest的方法前，需要先通过[createHttp\(\)](#httpcreatehttp)创建一个任务。 HTTP请求任务。在调用HttpRequest的方法前，需要先通过[createHttp()](#httpcreatehttp)创建一个任务。
### request ### request
request\(url: string, callback: AsyncCallback\<HttpResponse\>\):void request(url: string, callback: AsyncCallback\<HttpResponse\>):void
根据URL地址，发起HTTP网络请求，使用callback方式作为异步方法。 根据URL地址，发起HTTP网络请求，使用callback方式作为异步方法。
...@@ -140,7 +140,7 @@ httpRequest.request("EXAMPLE_URL", (err, data) => { ...@@ -140,7 +140,7 @@ httpRequest.request("EXAMPLE_URL", (err, data) => {
### request ### request
request\(url: string, options: HttpRequestOptions, callback: AsyncCallback\<HttpResponse\>\):void request(url: string, options: HttpRequestOptions, callback: AsyncCallback\<HttpResponse\>):void
根据URL地址和相关配置项，发起HTTP网络请求，使用callback方式作为异步方法。 根据URL地址和相关配置项，发起HTTP网络请求，使用callback方式作为异步方法。
...@@ -223,7 +223,7 @@ httpRequest.request("EXAMPLE_URL", ...@@ -223,7 +223,7 @@ httpRequest.request("EXAMPLE_URL",
### request ### request
request\(url: string, options? : HttpRequestOptions\): Promise\<HttpResponse\> request(url: string, options? : HttpRequestOptions): Promise\<HttpResponse\>
根据URL地址，发起HTTP网络请求，使用Promise方式作为异步方法。 根据URL地址，发起HTTP网络请求，使用Promise方式作为异步方法。
...@@ -309,7 +309,7 @@ promise.then((data) => { ...@@ -309,7 +309,7 @@ promise.then((data) => {
### destroy ### destroy
destroy\(\): void destroy(): void
中断请求任务。 中断请求任务。
...@@ -323,7 +323,7 @@ httpRequest.destroy(); ...@@ -323,7 +323,7 @@ httpRequest.destroy();
### request2<sup>10+</sup> ### request2<sup>10+</sup>
request2(url: string, callback: AsyncCallback<void>): void request2(url: string, callback: AsyncCallback\<void\>): void
根据URL地址和相关配置项，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。 根据URL地址和相关配置项，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。
...@@ -359,7 +359,7 @@ request2(url: string, callback: AsyncCallback<void>): void ...@@ -359,7 +359,7 @@ request2(url: string, callback: AsyncCallback<void>): void
```js ```js
httpRequest.request2("EXAMPLE_URL", (err) => { httpRequest.request2("EXAMPLE_URL", (err) => {
if (!err) { if (!err) {
console.info(request2 OK!); console.info("request2 OK!");
} else { } else {
console.info("request2 ERROR : err = " + JSON.stringify(err)); console.info("request2 ERROR : err = " + JSON.stringify(err));
} }
...@@ -368,7 +368,7 @@ httpRequest.request2("EXAMPLE_URL", (err) => { ...@@ -368,7 +368,7 @@ httpRequest.request2("EXAMPLE_URL", (err) => {
### request2<sup>10+</sup> ### request2<sup>10+</sup>
request2(url: string, options: HttpRequestOptions, callback: AsyncCallback<void>): void request2(url: string, options: HttpRequestOptions, callback: AsyncCallback\<void\>): void
根据URL地址和相关配置项，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。 根据URL地址和相关配置项，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。
...@@ -437,7 +437,7 @@ httpRequest.request2("EXAMPLE_URL", ...@@ -437,7 +437,7 @@ httpRequest.request2("EXAMPLE_URL",
connectTimeout: 60000 connectTimeout: 60000
}, (err) => { }, (err) => {
if (!err) { if (!err) {
console.info(request2 OK!); console.info("request2 OK!");
} else { } else {
console.info("request2 ERROR : err = " + JSON.stringify(err)); console.info("request2 ERROR : err = " + JSON.stringify(err));
} }
...@@ -445,7 +445,7 @@ httpRequest.request2("EXAMPLE_URL", ...@@ -445,7 +445,7 @@ httpRequest.request2("EXAMPLE_URL",
``` ```
### request2<sup>10+</sup> ### request2<sup>10+</sup>
request2\(url: string, options? : HttpRequestOptions\): Promise\<void\> request2(url: string, options? : HttpRequestOptions): Promise\<void\>
根据URL地址，发起HTTP网络请求并返回流式响应，使用Promise方式作为异步方法。 根据URL地址，发起HTTP网络请求并返回流式响应，使用Promise方式作为异步方法。
...@@ -518,20 +518,20 @@ let promise = httpRequest.request("EXAMPLE_URL", { ...@@ -518,20 +518,20 @@ let promise = httpRequest.request("EXAMPLE_URL", {
} }
}); });
promise.then(() => { promise.then(() => {
console.info(request2 OK!); console.info("request2 OK!");
}).catch((err) => { }).catch((err) => {
console.info("request2 ERROR : err = " + JSON.stringify(err)); console.info("request2 ERROR : err = " + JSON.stringify(err));
}); });
``` ```
### on\('headerReceive'\) ### on('headerReceive')
on\(type: 'headerReceive', callback: AsyncCallback<Object\>\): void on(type: 'headerReceive', callback: AsyncCallback\<Object\>): void
订阅HTTP Response Header 事件。 订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>此接口已废弃，建议使用[on\('headersReceive'\)<sup>8+</sup>](#onheadersreceive8)替代。 >此接口已废弃，建议使用[on('headersReceive')<sup>8+</sup>](#onheadersreceive8)替代。
**系统能力**：SystemCapability.Communication.NetStack **系统能力**：SystemCapability.Communication.NetStack
...@@ -554,15 +554,15 @@ httpRequest.on('headerReceive', (err, data) => { ...@@ -554,15 +554,15 @@ httpRequest.on('headerReceive', (err, data) => {
}); });
``` ```
### off\('headerReceive'\) ### off('headerReceive')
off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\): void off(type: 'headerReceive', callback?: AsyncCallback\<Object\>): void
取消订阅HTTP Response Header 事件。 取消订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
> >
>1. 此接口已废弃，建议使用[off\('headersReceive'\)<sup>8+</sup>](#offheadersreceive8)替代。 >1. 此接口已废弃，建议使用[off('headersReceive')<sup>8+</sup>](#offheadersreceive8)替代。
> >
>2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >2. 可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
...@@ -581,9 +581,9 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\): void ...@@ -581,9 +581,9 @@ off\(type: 'headerReceive', callback?: AsyncCallback<Object\>\): void
httpRequest.off('headerReceive'); httpRequest.off('headerReceive');
``` ```
### on\('headersReceive'\)<sup>8+</sup> ### on('headersReceive')<sup>8+</sup>
on\(type: 'headersReceive', callback: Callback<Object\>\): void on(type: 'headersReceive', callback: Callback\<Object\>): void
订阅HTTP Response Header 事件。 订阅HTTP Response Header 事件。
...@@ -604,9 +604,9 @@ httpRequest.on('headersReceive', (header) => { ...@@ -604,9 +604,9 @@ httpRequest.on('headersReceive', (header) => {
}); });
``` ```
### off\('headersReceive'\)<sup>8+</sup> ### off('headersReceive')<sup>8+</sup>
off\(type: 'headersReceive', callback?: Callback<Object\>\): void off(type: 'headersReceive', callback?: Callback\<Object\>): void
取消订阅HTTP Response Header 事件。 取消订阅HTTP Response Header 事件。
...@@ -628,9 +628,9 @@ off\(type: 'headersReceive', callback?: Callback<Object\>\): void ...@@ -628,9 +628,9 @@ off\(type: 'headersReceive', callback?: Callback<Object\>\): void
httpRequest.off('headersReceive'); httpRequest.off('headersReceive');
``` ```
### once\('headersReceive'\)<sup>8+</sup> ### once('headersReceive')<sup>8+</sup>
once\(type: 'headersReceive', callback: Callback<Object\>\): void once(type: 'headersReceive', callback: Callback\<Object\>): void
订阅HTTP Response Header 事件，但是只触发一次。一旦触发之后，订阅器就会被移除。使用callback方式作为异步方法。 订阅HTTP Response Header 事件，但是只触发一次。一旦触发之后，订阅器就会被移除。使用callback方式作为异步方法。
...@@ -650,9 +650,9 @@ httpRequest.once('headersReceive', (header) => { ...@@ -650,9 +650,9 @@ httpRequest.once('headersReceive', (header) => {
console.info('header: ' + JSON.stringify(header)); console.info('header: ' + JSON.stringify(header));
}); });
``` ```
### on\('dataReceive'\)<sup>10+</sup> ### on('dataReceive')<sup>10+</sup>
on\(type: 'dataReceive', callback: Callback\<ArrayBuffer\>\): void on(type: 'dataReceive', callback: Callback\<ArrayBuffer\>): void
订阅HTTP流式响应数据接收事件。 订阅HTTP流式响应数据接收事件。
...@@ -673,9 +673,9 @@ httpRequest.on('dataReceive', (data) => { ...@@ -673,9 +673,9 @@ httpRequest.on('dataReceive', (data) => {
}); });
``` ```
### off\('dataReceive'\)<sup>10+</sup> ### off('dataReceive')<sup>10+</sup>
off\(type: 'dataReceive', callback?: Callback\<ArrayBuffer\>\): void off(type: 'dataReceive', callback?: Callback\<ArrayBuffer\>): void
取消订阅HTTP流式响应数据接收事件。 取消订阅HTTP流式响应数据接收事件。
...@@ -697,9 +697,9 @@ off\(type: 'dataReceive', callback?: Callback\<ArrayBuffer\>\): void ...@@ -697,9 +697,9 @@ off\(type: 'dataReceive', callback?: Callback\<ArrayBuffer\>\): void
httpRequest.off('dataReceive'); httpRequest.off('dataReceive');
``` ```
### on\('dataEnd'\)<sup>10+</sup> ### on('dataEnd')<sup>10+</sup>
on\(type: 'dataEnd', callback: Callback\<void\>\): void on(type: 'dataEnd', callback: Callback\<void\>): void
订阅HTTP流式响应数据接收完毕事件。 订阅HTTP流式响应数据接收完毕事件。
...@@ -720,7 +720,7 @@ httpRequest.on('dataReceive', () => { ...@@ -720,7 +720,7 @@ httpRequest.on('dataReceive', () => {
}); });
``` ```
### off\('dataEnd'\)<sup>10+</sup> ### off('dataEnd')<sup>10+</sup>
off(type: 'dataEnd', callback?: Callback\<void\>): void off(type: 'dataEnd', callback?: Callback\<void\>): void
...@@ -744,9 +744,9 @@ off(type: 'dataEnd', callback?: Callback\<void\>): void ...@@ -744,9 +744,9 @@ off(type: 'dataEnd', callback?: Callback\<void\>): void
httpRequest.off('dataEnd'); httpRequest.off('dataEnd');
``` ```
### on\('dataProgress'\)<sup>10+</sup> ### on('dataProgress')<sup>10+</sup>
on\(type: 'dataProgress', callback: Callback\<{ receiveSize: number, totalSize: number }\>\): void on(type: 'dataProgress', callback: Callback\<{ receiveSize: number, totalSize: number }\>): void
订阅HTTP流式响应数据接收进度事件。 订阅HTTP流式响应数据接收进度事件。
...@@ -757,7 +757,7 @@ httpRequest.off('dataEnd'); ...@@ -757,7 +757,7 @@ httpRequest.off('dataEnd');
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | --------------------------------- | | -------- | ----------------------- | ---- | --------------------------------- |
| type | string | 是 | 订阅的事件类型，'dataProgress'。 | | type | string | 是 | 订阅的事件类型，'dataProgress'。 |
| callback | AsyncCallback\<{ receiveSize: number, totalSize: number }\> | 是 | 回调函数。 | | callback | AsyncCallback\<{ receiveSize: number, totalSize: number }\> | 是 | 回调函数。<br>receiveSize：已接收的数据字节数，totalSize待接收的字节总数 |
**示例：** **示例：**
...@@ -769,7 +769,7 @@ httpRequest.on('dataProgress', (data) => { ...@@ -769,7 +769,7 @@ httpRequest.on('dataProgress', (data) => {
}); });
``` ```
### off\('dataProgress'\)<sup>10+</sup> ### off('dataProgress')<sup>10+</sup>
off(type: 'dataProgress', callback?: Callback\<{ receiveSize: number, totalSize: number }\>): void off(type: 'dataProgress', callback?: Callback\<{ receiveSize: number, totalSize: number }\>): void
...@@ -919,7 +919,7 @@ let httpResponseCache = http.createHttpResponseCache(); ...@@ -919,7 +919,7 @@ let httpResponseCache = http.createHttpResponseCache();
### flush<sup>9+</sup> ### flush<sup>9+</sup>
flush(callback: AsyncCallback\<void>): void flush(callback: AsyncCallback\<void\>): void
将缓存中的数据写入文件系统，以便在下一个HTTP请求中访问所有缓存数据，使用callback方式作为异步方法。 将缓存中的数据写入文件系统，以便在下一个HTTP请求中访问所有缓存数据，使用callback方式作为异步方法。
...@@ -929,7 +929,7 @@ flush(callback: AsyncCallback\<void>): void ...@@ -929,7 +929,7 @@ flush(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- | | -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<void> | 是 | 回调函数返回写入结果。 | | callback | AsyncCallback\<void\> | 是 | 回调函数返回写入结果。 |
**示例：** **示例：**
...@@ -945,7 +945,7 @@ httpResponseCache.flush(err => { ...@@ -945,7 +945,7 @@ httpResponseCache.flush(err => {
### flush<sup>9+</sup> ### flush<sup>9+</sup>
flush(): Promise\<void> flush(): Promise\<void\>
将缓存中的数据写入文件系统，以便在下一个HTTP请求中访问所有缓存数据，使用Promise方式作为异步方法。 将缓存中的数据写入文件系统，以便在下一个HTTP请求中访问所有缓存数据，使用Promise方式作为异步方法。
...@@ -955,7 +955,7 @@ flush(): Promise\<void> ...@@ -955,7 +955,7 @@ flush(): Promise\<void>
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------- | ------------------------------------- | | --------------------------------- | ------------------------------------- |
| Promise\<void>> | 以Promise形式返回写入结果。 | | Promise\<void\> | 以Promise形式返回写入结果。 |
**示例：** **示例：**
...@@ -969,7 +969,7 @@ httpResponseCache.flush().then(() => { ...@@ -969,7 +969,7 @@ httpResponseCache.flush().then(() => {
### delete<sup>9+</sup> ### delete<sup>9+</sup>
delete(callback: AsyncCallback\<void>): void delete(callback: AsyncCallback\<void\>): void
禁用缓存并删除其中的数据，使用callback方式作为异步方法。 禁用缓存并删除其中的数据，使用callback方式作为异步方法。
...@@ -979,7 +979,7 @@ delete(callback: AsyncCallback\<void>): void ...@@ -979,7 +979,7 @@ delete(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------- | ---- | ---------- | | -------- | --------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<void> | 是 | 回调函数返回删除结果。| | callback | AsyncCallback\<void\> | 是 | 回调函数返回删除结果。|
**示例：** **示例：**
...@@ -994,7 +994,7 @@ httpResponseCache.delete(err => { ...@@ -994,7 +994,7 @@ httpResponseCache.delete(err => {
``` ```
### delete<sup>9+</sup> ### delete<sup>9+</sup>
delete(): Promise\<void> delete(): Promise\<void\>
禁用缓存并删除其中的数据，使用Promise方式作为异步方法。 禁用缓存并删除其中的数据，使用Promise方式作为异步方法。
...@@ -1004,7 +1004,7 @@ delete(): Promise\<void> ...@@ -1004,7 +1004,7 @@ delete(): Promise\<void>
| 类型 | 说明 | | 类型 | 说明 |
| --------------------------------- | ------------------------------------- | | --------------------------------- | ------------------------------------- |
| Promise\<void> | 以Promise形式返回删除结果。 | | Promise\<void\> | 以Promise形式返回删除结果。 |
**示例：** **示例：**
...@@ -1023,7 +1023,7 @@ http的数据类型。 ...@@ -1023,7 +1023,7 @@ http的数据类型。
**系统能力**：SystemCapability.Communication.NetStack **系统能力**：SystemCapability.Communication.NetStack
| 名称 | 值 | 说明 | | 名称 | 值 | 说明 |
| ------------------ | -- | ----------- | | ------------------ | -- | ----------- |
| STRING | 0 | 字符串类型。 | | STRING | 0 | 字符串类型。 |
| OBJECT | 1 | 对象类型。 | | OBJECT | 1 | 对象类型。 |
| ARRAY_BUFFER | 2 | 二进制数组类型。| | ARRAY_BUFFER | 2 | 二进制数组类型。|
......
zh-cn/application-dev/reference/apis/js-apis-socket.md
浏览文件 @ 65460701
...@@ -12,7 +12,7 @@ import socket from '@ohos.net.socket'; ...@@ -12,7 +12,7 @@ import socket from '@ohos.net.socket';
## socket.constructUDPSocketInstance ## socket.constructUDPSocketInstance
constructUDPSocketInstance\(\): UDPSocket constructUDPSocketInstance(): UDPSocket
创建一个UDPSocket对象。 创建一个UDPSocket对象。
...@@ -38,7 +38,7 @@ UDPSocket连接。在调用UDPSocket的方法前，需要先通过[socket.constr ...@@ -38,7 +38,7 @@ UDPSocket连接。在调用UDPSocket的方法前，需要先通过[socket.constr
### bind ### bind
bind\(address: NetAddress, callback: AsyncCallback<void\>\): void bind(address: NetAddress, callback: AsyncCallback\<void\>): void
绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方式作为异步方法。 绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方式作为异步方法。
...@@ -76,7 +76,7 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { ...@@ -76,7 +76,7 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
### bind ### bind
bind\(address: NetAddress\): Promise<void\> bind(address: NetAddress): Promise\<void\>
绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方式作为异步方法。 绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方式作为异步方法。
...@@ -118,7 +118,7 @@ promise .then(() => { ...@@ -118,7 +118,7 @@ promise .then(() => {
### send ### send
send\(options: UDPSendOptions, callback: AsyncCallback<void\>\): void send(options: UDPSendOptions, callback: AsyncCallback\<void\>): void
通过UDPSocket连接发送数据。使用callback方式作为异步方法。 通过UDPSocket连接发送数据。使用callback方式作为异步方法。
...@@ -165,7 +165,7 @@ udp.send({ ...@@ -165,7 +165,7 @@ udp.send({
### send ### send
send\(options: UDPSendOptions\): Promise<void\> send(options: UDPSendOptions): Promise\<void\>
通过UDPSocket连接发送数据。使用Promise方式作为异步方法。 通过UDPSocket连接发送数据。使用Promise方式作为异步方法。
...@@ -216,7 +216,7 @@ promise.then(() => { ...@@ -216,7 +216,7 @@ promise.then(() => {
### close ### close
close\(callback: AsyncCallback<void\>\): void close(callback: AsyncCallback\<void\>): void
关闭UDPSocket连接。使用callback方式作为异步方法。 关闭UDPSocket连接。使用callback方式作为异步方法。
...@@ -246,7 +246,7 @@ udp.close(err => { ...@@ -246,7 +246,7 @@ udp.close(err => {
### close ### close
close\(\): Promise<void\> close(): Promise\<void\>
关闭UDPSocket连接。使用Promise方式作为异步方法。 关闭UDPSocket连接。使用Promise方式作为异步方法。
...@@ -275,12 +275,12 @@ promise.then(() => { ...@@ -275,12 +275,12 @@ promise.then(() => {
### getState ### getState
getState\(callback: AsyncCallback<SocketStateBase\>\): void getState(callback: AsyncCallback\<SocketStateBase\>): void
获取UDPSocket状态。使用callback方式作为异步方法。 获取UDPSocket状态。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#bind)方法调用成功后，才可调用此方法。 >bind方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -321,12 +321,12 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { ...@@ -321,12 +321,12 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
### getState ### getState
getState\(\): Promise<SocketStateBase\> getState(): Promise\<SocketStateBase\>
获取UDPSocket状态。使用Promise方式作为异步方法。 获取UDPSocket状态。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#bind)方法调用成功后，才可调用此方法。 >bind方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -336,7 +336,7 @@ getState\(\): Promise<SocketStateBase\> ...@@ -336,7 +336,7 @@ getState\(\): Promise<SocketStateBase\>
| 类型 | 说明 | | 类型 | 说明 |
| :----------------------------------------------- | :----------------------------------------- | | :----------------------------------------------- | :----------------------------------------- |
| Promise<[SocketStateBase](#socketstatebase)> | 以Promise形式返回获取UDPSocket状态的结果。 | | Promise\<[SocketStateBase](#socketstatebase)\> | 以Promise形式返回获取UDPSocket状态的结果。 |
**示例：** **示例：**
...@@ -360,12 +360,12 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { ...@@ -360,12 +360,12 @@ udp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
### setExtraOptions ### setExtraOptions
setExtraOptions\(options: UDPExtraOptions, callback: AsyncCallback<void\>\): void setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback\<void\>): void
设置UDPSocket连接的其他属性。使用callback方式作为异步方法。 设置UDPSocket连接的其他属性。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#bind)方法调用成功后，才可调用此方法。 >bind方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -414,12 +414,12 @@ udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1}, err=> { ...@@ -414,12 +414,12 @@ udp.bind({address:'192.168.xx.xxx', port:xxxx, family:1}, err=> {
### setExtraOptions ### setExtraOptions
setExtraOptions\(options: UDPExtraOptions\): Promise<void\> setExtraOptions(options: UDPExtraOptions): Promise\<void\>
设置UDPSocket连接的其他属性。使用Promise方式作为异步方法。 设置UDPSocket连接的其他属性。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#bind)方法调用成功后，才可调用此方法。 >bind方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -469,9 +469,9 @@ promise.then(() => { ...@@ -469,9 +469,9 @@ promise.then(() => {
``` ```
### on\('message'\) ### on('message')
on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: SocketRemoteInfo\}\>\): void on(type: 'message', callback: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。 订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
...@@ -482,7 +482,7 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock ...@@ -482,7 +482,7 @@ on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: Sock
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- | | -------- | ------------------------------------------------------------ | ---- | ----------------------------------------- |
| type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 | | type | string | 是 | 订阅的事件类型。'message'：接收消息事件。 |
| callback | Callback<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}> | 是 | 回调函数。 | | callback | Callback\<{message: ArrayBuffer, remoteInfo: [SocketRemoteInfo](#socketremoteinfo)}\> | 是 | 回调函数。 |
**示例：** **示例：**
...@@ -494,9 +494,9 @@ udp.on('message', value => { ...@@ -494,9 +494,9 @@ udp.on('message', value => {
``` ```
### off\('message'\) ### off('message')
off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: SocketRemoteInfo\}\>\): void off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
取消订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。 取消订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
...@@ -526,9 +526,9 @@ udp.off('message'); ...@@ -526,9 +526,9 @@ udp.off('message');
``` ```
### on\('listening' | 'close'\) ### on('listening' | 'close')
on\(type: 'listening' | 'close', callback: Callback<void\>\): void on(type: 'listening' | 'close', callback: Callback\<void\>): void
订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。 订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
...@@ -554,9 +554,9 @@ udp.on('close', () => { ...@@ -554,9 +554,9 @@ udp.on('close', () => {
``` ```
### off\('listening' | 'close'\) ### off('listening' | 'close')
off\(type: 'listening' | 'close', callback?: Callback<void\>\): void off(type: 'listening' | 'close', callback?: Callback\<void\>): void
取消订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。 取消订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
...@@ -593,9 +593,9 @@ udp.off('close'); ...@@ -593,9 +593,9 @@ udp.off('close');
``` ```
### on\('error'\) ### on('error')
on\(type: 'error', callback: ErrorCallback\): void on(type: 'error', callback: ErrorCallback): void
订阅UDPSocket连接的error事件。使用callback方式作为异步方法。 订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
...@@ -618,9 +618,9 @@ udp.on('error', err => { ...@@ -618,9 +618,9 @@ udp.on('error', err => {
``` ```
### off\('error'\) ### off('error')
off\(type: 'error', callback?: ErrorCallback\): void off(type: 'error', callback?: ErrorCallback): void
取消订阅UDPSocket连接的error事件。使用callback方式作为异步方法。 取消订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
...@@ -720,7 +720,7 @@ UDP 其余错误码映射形式为：2301000 + Linux内核错误码。 ...@@ -720,7 +720,7 @@ UDP 其余错误码映射形式为：2301000 + Linux内核错误码。
## socket.constructTCPSocketInstance ## socket.constructTCPSocketInstance
constructTCPSocketInstance\(\): TCPSocket constructTCPSocketInstance(): TCPSocket
创建一个TCPSocket对象。 创建一个TCPSocket对象。
...@@ -745,7 +745,7 @@ TCPSocket连接。在调用TCPSocket的方法前，需要先通过[socket.constr ...@@ -745,7 +745,7 @@ TCPSocket连接。在调用TCPSocket的方法前，需要先通过[socket.constr
### bind ### bind
bind\(address: NetAddress, callback: AsyncCallback<void\>\): void bind(address: NetAddress, callback: AsyncCallback\<void\>): void
绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方法作为异步方法。 绑定IP地址和端口，端口可以指定或由系统随机分配。使用callback方法作为异步方法。
...@@ -783,7 +783,7 @@ tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { ...@@ -783,7 +783,7 @@ tcp.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
### bind ### bind
bind\(address: NetAddress\): Promise<void\> bind(address: NetAddress): Promise\<void\>
绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方法作为异步方法。 绑定IP地址和端口，端口可以指定或由系统随机分配。使用Promise方法作为异步方法。
...@@ -825,10 +825,13 @@ promise.then(() => { ...@@ -825,10 +825,13 @@ promise.then(() => {
### connect ### connect
connect\(options: TCPConnectOptions, callback: AsyncCallback<void\>\): void connect(options: TCPConnectOptions, callback: AsyncCallback\<void\>): void
连接到指定的IP地址和端口。使用callback方法作为异步方法。 连接到指定的IP地址和端口。使用callback方法作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：**
>bind方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
**系统能力**：SystemCapability.Communication.NetStack **系统能力**：SystemCapability.Communication.NetStack
...@@ -863,7 +866,7 @@ tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , time ...@@ -863,7 +866,7 @@ tcp.connect({ address: {address: '192.168.xx.xxx', port: xxxx, family: 1} , time
### connect ### connect
connect\(options: TCPConnectOptions\): Promise<void\> connect(options: TCPConnectOptions): Promise\<void\>
连接到指定的IP地址和端口。使用promise方法作为异步方法。 连接到指定的IP地址和端口。使用promise方法作为异步方法。
...@@ -905,12 +908,12 @@ promise.then(() => { ...@@ -905,12 +908,12 @@ promise.then(() => {
### send ### send
send\(options: TCPSendOptions, callback: AsyncCallback<void\>\): void send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void
通过TCPSocket连接发送数据。使用callback方式作为异步方法。 通过TCPSocket连接发送数据。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[connect](#connect)方法调用成功后，才可调用此方法。 >connect方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -954,12 +957,12 @@ promise.then(() => { ...@@ -954,12 +957,12 @@ promise.then(() => {
### send ### send
send\(options: TCPSendOptions\): Promise<void\> send(options: TCPSendOptions): Promise\<void\>
通过TCPSocket连接发送数据。使用Promise方式作为异步方法。 通过TCPSocket连接发送数据。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[connect](#connect)方法调用成功后，才可调用此方法。 >connect方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -1007,7 +1010,7 @@ promise1.then(() => { ...@@ -1007,7 +1010,7 @@ promise1.then(() => {
### close ### close
close\(callback: AsyncCallback<void\>\): void close(callback: AsyncCallback\<void\>): void
关闭TCPSocket连接。使用callback方式作为异步方法。 关闭TCPSocket连接。使用callback方式作为异步方法。
...@@ -1043,7 +1046,7 @@ tcp.close(err => { ...@@ -1043,7 +1046,7 @@ tcp.close(err => {
### close ### close
close\(\): Promise<void\> close(): Promise\<void\>
关闭TCPSocket连接。使用Promise方式作为异步方法。 关闭TCPSocket连接。使用Promise方式作为异步方法。
...@@ -1078,12 +1081,12 @@ promise.then(() => { ...@@ -1078,12 +1081,12 @@ promise.then(() => {
### getRemoteAddress ### getRemoteAddress
getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
获取对端Socket地址。使用callback方式作为异步方法。 获取对端Socket地址。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[connect](#connect)方法调用成功后，才可调用此方法。 >connect方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -1123,12 +1126,12 @@ promise.then(() => { ...@@ -1123,12 +1126,12 @@ promise.then(() => {
### getRemoteAddress ### getRemoteAddress
getRemoteAddress\(\): Promise<NetAddress\> getRemoteAddress(): Promise\<NetAddress\>
获取对端Socket地址。使用Promise方式作为异步方法。 获取对端Socket地址。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[connect](#connect)方法调用成功后，才可调用此方法。 >connect方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -1167,12 +1170,12 @@ promise1.then(() => { ...@@ -1167,12 +1170,12 @@ promise1.then(() => {
### getState ### getState
getState\(callback: AsyncCallback<SocketStateBase\>\): void getState(callback: AsyncCallback\<SocketStateBase\>): void
获取TCPSocket状态。使用callback方式作为异步方法。 获取TCPSocket状态。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#bind)或[connect](#connect)方法调用成功后，才可调用此方法。 >bind或connect方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -1212,12 +1215,12 @@ promise.then(() => { ...@@ -1212,12 +1215,12 @@ promise.then(() => {
### getState ### getState
getState\(\): Promise<SocketStateBase\> getState(): Promise\<SocketStateBase\>
获取TCPSocket状态。使用Promise方式作为异步方法。 获取TCPSocket状态。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#bind)或[connect](#connect)方法调用成功后，才可调用此方法。 >bind或connect方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -1256,12 +1259,12 @@ promise.then(() => { ...@@ -1256,12 +1259,12 @@ promise.then(() => {
### setExtraOptions ### setExtraOptions
setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): void setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
设置TCPSocket连接的其他属性。使用callback方式作为异步方法。 设置TCPSocket连接的其他属性。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#bind)或[connect](#connect)方法调用成功后，才可调用此方法。 >bind或connect方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -1312,12 +1315,12 @@ promise.then(() => { ...@@ -1312,12 +1315,12 @@ promise.then(() => {
### setExtraOptions ### setExtraOptions
setExtraOptions\(options: TCPExtraOptions\): Promise<void\> setExtraOptions(options: TCPExtraOptions): Promise\<void\>
设置TCPSocket连接的其他属性，使用Promise方式作为异步方法。 设置TCPSocket连接的其他属性，使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>[bind](#bind)或[connect](#connect)方法调用成功后，才可调用此方法。 >bind或connect方法调用成功后，才可调用此方法。
**需要权限**：ohos.permission.INTERNET **需要权限**：ohos.permission.INTERNET
...@@ -1370,9 +1373,9 @@ promise.then(() => { ...@@ -1370,9 +1373,9 @@ promise.then(() => {
``` ```
### on\('message'\) ### on('message')
on\(type: 'message', callback: Callback<\{message: ArrayBuffer, remoteInfo: SocketRemoteInfo\}\>\): void on(type: 'message', callback: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。 订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
...@@ -1395,9 +1398,9 @@ tcp.on('message', value => { ...@@ -1395,9 +1398,9 @@ tcp.on('message', value => {
``` ```
### off\('message'\) ### off('message')
off\(type: 'message', callback?: Callback<\{message: ArrayBuffer, remoteInfo: SocketRemoteInfo\}\>\): void off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: SocketRemoteInfo}\>): void
取消订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。 取消订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
...@@ -1427,9 +1430,9 @@ tcp.off('message'); ...@@ -1427,9 +1430,9 @@ tcp.off('message');
``` ```
### on\('connect' | 'close'\) ### on('connect' | 'close')
on\(type: 'connect' | 'close', callback: Callback<void\>\): void on(type: 'connect' | 'close', callback: Callback\<void\>): void
订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。 订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
...@@ -1455,9 +1458,9 @@ tcp.on('close', data => { ...@@ -1455,9 +1458,9 @@ tcp.on('close', data => {
``` ```
### off\('connect' | 'close'\) ### off('connect' | 'close')
off\(type: 'connect' | 'close', callback?: Callback<void\>\): void off(type: 'connect' | 'close', callback?: Callback\<void\>): void
取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。 取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
...@@ -1494,9 +1497,9 @@ tcp.off('close'); ...@@ -1494,9 +1497,9 @@ tcp.off('close');
``` ```
### on\('error'\) ### on('error')
on\(type: 'error', callback: ErrorCallback\): void on(type: 'error', callback: ErrorCallback): void
订阅TCPSocket连接的error事件。使用callback方式作为异步方法。 订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
...@@ -1519,9 +1522,9 @@ tcp.on('error', err => { ...@@ -1519,9 +1522,9 @@ tcp.on('error', err => {
``` ```
### off\('error'\) ### off('error')
off\(type: 'error', callback?: ErrorCallback\): void off(type: 'error', callback?: ErrorCallback): void
取消订阅TCPSocket连接的error事件。使用callback方式作为异步方法。 取消订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
...@@ -1622,7 +1625,7 @@ TLSSocket连接。在调用TLSSocket的方法前，需要先通过[socket.constr ...@@ -1622,7 +1625,7 @@ TLSSocket连接。在调用TLSSocket的方法前，需要先通过[socket.constr
### bind<sup>9+</sup> ### bind<sup>9+</sup>
bind\(address: NetAddress, callback: AsyncCallback<void\>\): void bind(address: NetAddress, callback: AsyncCallback\<void\>): void
绑定IP地址和端口。使用callback方法作为异步方法。 绑定IP地址和端口。使用callback方法作为异步方法。
...@@ -1660,7 +1663,7 @@ tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => { ...@@ -1660,7 +1663,7 @@ tls.bind({address: '192.168.xx.xxx', port: xxxx, family: 1}, err => {
### bind<sup>9+</sup> ### bind<sup>9+</sup>
bind\(address: NetAddress\): Promise<void\> bind(address: NetAddress): Promise\<void\>
绑定IP地址和端口。使用Promise方法作为异步方法。 绑定IP地址和端口。使用Promise方法作为异步方法。
...@@ -1702,7 +1705,7 @@ promise.then(() => { ...@@ -1702,7 +1705,7 @@ promise.then(() => {
### getState<sup>9+</sup> ### getState<sup>9+</sup>
getState\(callback: AsyncCallback<SocketStateBase\>\): void getState(callback: AsyncCallback\<SocketStateBase\>): void
在TLSSocket的bind成功之后，获取TLSSocket状态。使用callback方式作为异步方法。 在TLSSocket的bind成功之后，获取TLSSocket状态。使用callback方式作为异步方法。
...@@ -1742,7 +1745,7 @@ tls.getState((err, data) => { ...@@ -1742,7 +1745,7 @@ tls.getState((err, data) => {
### getState<sup>9+</sup> ### getState<sup>9+</sup>
getState\(\): Promise<SocketStateBase\> getState(): Promise\<SocketStateBase\>
在TLSSocket的bind成功之后，获取TLSSocket状态。使用Promise方式作为异步方法。 在TLSSocket的bind成功之后，获取TLSSocket状态。使用Promise方式作为异步方法。
...@@ -1781,7 +1784,7 @@ promise.then(() => { ...@@ -1781,7 +1784,7 @@ promise.then(() => {
### setExtraOptions<sup>9+</sup> ### setExtraOptions<sup>9+</sup>
setExtraOptions\(options: TCPExtraOptions, callback: AsyncCallback<void\>\): void setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
在TLSSocket的bind成功之后，设置TCPSocket连接的其他属性。使用callback方式作为异步方法。 在TLSSocket的bind成功之后，设置TCPSocket连接的其他属性。使用callback方式作为异步方法。
...@@ -1833,7 +1836,7 @@ tls.setExtraOptions({ ...@@ -1833,7 +1836,7 @@ tls.setExtraOptions({
### setExtraOptions<sup>9+</sup> ### setExtraOptions<sup>9+</sup>
setExtraOptions\(options: TCPExtraOptions\): Promise<void\> setExtraOptions(options: TCPExtraOptions): Promise\<void\>
在TLSSocket的bind成功之后，设置TCPSocket连接的其他属性，使用Promise方式作为异步方法。 在TLSSocket的bind成功之后，设置TCPSocket连接的其他属性，使用Promise方式作为异步方法。
...@@ -1888,7 +1891,7 @@ promise.then(() => { ...@@ -1888,7 +1891,7 @@ promise.then(() => {
### connect<sup>9+</sup> ### connect<sup>9+</sup>
connect(options: TLSConnectOptions, callback: AsyncCallback\<void>): void connect(options: TLSConnectOptions, callback: AsyncCallback\<void\>): void
在TLSSocket上bind成功之后，进行通信连接，并创建和初始化TLS会话，实现建立连接过程，启动与服务器的TLS/SSL握手，实现数据传输功能，使用callback方式作为异步方法。 在TLSSocket上bind成功之后，进行通信连接，并创建和初始化TLS会话，实现建立连接过程，启动与服务器的TLS/SSL握手，实现数据传输功能，使用callback方式作为异步方法。
...@@ -1982,7 +1985,7 @@ tlsOneWay.connect(oneWayOptions, (err, data) => { ...@@ -1982,7 +1985,7 @@ tlsOneWay.connect(oneWayOptions, (err, data) => {
### connect<sup>9+</sup> ### connect<sup>9+</sup>
connect(options: TLSConnectOptions): Promise\<void> connect(options: TLSConnectOptions): Promise\<void\>
在TLSSocket上bind成功之后，进行通信连接，并创建和初始化TLS会话，实现建立连接过程，启动与服务器的TLS/SSL握手，实现数据传输功能，该连接包括两种认证方式，单向认证与双向认证，使用Promise方式作为异步方法。 在TLSSocket上bind成功之后，进行通信连接，并创建和初始化TLS会话，实现建立连接过程，启动与服务器的TLS/SSL握手，实现数据传输功能，该连接包括两种认证方式，单向认证与双向认证，使用Promise方式作为异步方法。
...@@ -1998,7 +2001,7 @@ connect(options: TLSConnectOptions): Promise\<void> ...@@ -1998,7 +2001,7 @@ connect(options: TLSConnectOptions): Promise\<void>
| 类型 | 说明 | | 类型 | 说明 |
| ------------------------------------------- | ----------------------------- | | ------------------------------------------- | ----------------------------- |
| Promise\<void> | 以Promise形式返回，成功无返回，失败返回错误码，错误信息。| | Promise\<void\> | 以Promise形式返回，成功无返回，失败返回错误码，错误信息。|
**错误码：** **错误码：**
...@@ -2083,7 +2086,7 @@ tlsOneWay.connect(oneWayOptions).then(data => { ...@@ -2083,7 +2086,7 @@ tlsOneWay.connect(oneWayOptions).then(data => {
### getRemoteAddress<sup>9+</sup> ### getRemoteAddress<sup>9+</sup>
getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
在TLSSocket通信连接成功之后，获取对端Socket地址。使用callback方式作为异步方法。 在TLSSocket通信连接成功之后，获取对端Socket地址。使用callback方式作为异步方法。
...@@ -2093,7 +2096,7 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void ...@@ -2093,7 +2096,7 @@ getRemoteAddress\(callback: AsyncCallback<NetAddress\>\): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ------------------------------------------------- | ---- | ---------- | | -------- | ------------------------------------------------- | ---- | ---------- |
| callback | AsyncCallback\<[NetAddress](#netaddress)> | 是 | 回调函数。成功返回对端的socket地址，失败返回错误码，错误信息。 | | callback | AsyncCallback\<[NetAddress](#netaddress)\> | 是 | 回调函数。成功返回对端的socket地址，失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2116,7 +2119,7 @@ tls.getRemoteAddress((err, data) => { ...@@ -2116,7 +2119,7 @@ tls.getRemoteAddress((err, data) => {
### getRemoteAddress<sup>9+</sup> ### getRemoteAddress<sup>9+</sup>
getRemoteAddress\(\): Promise\<NetAddress> getRemoteAddress(): Promise\<NetAddress\>
在TLSSocket通信连接成功之后，获取对端Socket地址。使用Promise方式作为异步方法。 在TLSSocket通信连接成功之后，获取对端Socket地址。使用Promise方式作为异步方法。
...@@ -2148,7 +2151,7 @@ promise.then(() => { ...@@ -2148,7 +2151,7 @@ promise.then(() => {
### getCertificate<sup>9+</sup> ### getCertificate<sup>9+</sup>
getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)>): void getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>): void
在TLSSocket通信连接成功之后，获取本地的数字证书，该接口只适用于双向认证时，使用callback方式作为异步方法。 在TLSSocket通信连接成功之后，获取本地的数字证书，该接口只适用于双向认证时，使用callback方式作为异步方法。
...@@ -2158,7 +2161,7 @@ getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)>): ...@@ -2158,7 +2161,7 @@ getCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)>):
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------| | -------- | ----------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)> | 是 | 回调函数，成功返回本地的证书，失败返回错误码，错误信息。| | callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数，成功返回本地的证书，失败返回错误码，错误信息。|
**错误码：** **错误码：**
...@@ -2182,7 +2185,7 @@ tls.getCertificate((err, data) => { ...@@ -2182,7 +2185,7 @@ tls.getCertificate((err, data) => {
### getCertificate<sup>9+</sup> ### getCertificate<sup>9+</sup>
getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)> getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\>
在TLSSocket通信连接之后，获取本地的数字证书，该接口只适用于双向认证时，使用Promise方式作为异步方法。 在TLSSocket通信连接之后，获取本地的数字证书，该接口只适用于双向认证时，使用Promise方式作为异步方法。
...@@ -2192,7 +2195,7 @@ getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)> ...@@ -2192,7 +2195,7 @@ getCertificate():Promise\<[X509CertRawData](#x509certrawdata9)>
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | -------------- | -------------------- |
| Promise\<[X509CertRawData](#x509certrawdata9)> | 以Promise形式返回本地的数字证书的结果。失败返回错误码，错误信息。 | | Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回本地的数字证书的结果。失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2214,7 +2217,7 @@ tls.getCertificate().then(data => { ...@@ -2214,7 +2217,7 @@ tls.getCertificate().then(data => {
### getRemoteCertificate<sup>9+</sup> ### getRemoteCertificate<sup>9+</sup>
getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)>): void getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata9)\>): void
在TLSSocket通信连接成功之后，获取服务端的数字证书，使用callback方式作为异步方法。 在TLSSocket通信连接成功之后，获取服务端的数字证书，使用callback方式作为异步方法。
...@@ -2224,7 +2227,7 @@ getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata ...@@ -2224,7 +2227,7 @@ getRemoteCertificate(callback: AsyncCallback\<[X509CertRawData](#x509certrawdata
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------| | -------- | ----------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)> | 是 | 回调函数，返回服务端的证书。失败返回错误码，错误信息。 | | callback | AsyncCallback\<[X509CertRawData](#x509certrawdata9)\> | 是 | 回调函数，返回服务端的证书。失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2247,7 +2250,7 @@ tls.getRemoteCertificate((err, data) => { ...@@ -2247,7 +2250,7 @@ tls.getRemoteCertificate((err, data) => {
### getRemoteCertificate<sup>9+</sup> ### getRemoteCertificate<sup>9+</sup>
getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)> getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)\>
在TLSSocket通信连接成功之后，获取服务端的数字证书，使用Promise方式作为异步方法。 在TLSSocket通信连接成功之后，获取服务端的数字证书，使用Promise方式作为异步方法。
...@@ -2257,7 +2260,7 @@ getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)> ...@@ -2257,7 +2260,7 @@ getRemoteCertificate():Promise\<[X509CertRawData](#x509certrawdata9)>
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | -------------- | -------------------- |
| Promise\<[X509CertRawData](#x509certrawdata9)> | 以Promise形式返回服务端的数字证书的结果。失败返回错误码，错误信息。 | | Promise\<[X509CertRawData](#x509certrawdata9)\> | 以Promise形式返回服务端的数字证书的结果。失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2278,7 +2281,7 @@ tls.getRemoteCertificate().then(data => { ...@@ -2278,7 +2281,7 @@ tls.getRemoteCertificate().then(data => {
### getProtocol<sup>9+</sup> ### getProtocol<sup>9+</sup>
getProtocol(callback: AsyncCallback\<string>): void getProtocol(callback: AsyncCallback\<string\>): void
在TLSSocket通信连接成功之后，获取通信的协议版本，使用callback方式作为异步方法。 在TLSSocket通信连接成功之后，获取通信的协议版本，使用callback方式作为异步方法。
...@@ -2288,7 +2291,7 @@ getProtocol(callback: AsyncCallback\<string>): void ...@@ -2288,7 +2291,7 @@ getProtocol(callback: AsyncCallback\<string>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------| | -------- | ----------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<string> | 是 | 回调函数，返回通信的协议。失败返回错误码，错误信息。| | callback | AsyncCallback\<string\> | 是 | 回调函数，返回通信的协议。失败返回错误码，错误信息。|
**错误码：** **错误码：**
...@@ -2312,7 +2315,7 @@ tls.getProtocol((err, data) => { ...@@ -2312,7 +2315,7 @@ tls.getProtocol((err, data) => {
### getProtocol<sup>9+</sup> ### getProtocol<sup>9+</sup>
getProtocol():Promise\<string> getProtocol():Promise\<string\>
在TLSSocket通信连接成功之后，获取通信的协议版本，使用Promise方式作为异步方法。 在TLSSocket通信连接成功之后，获取通信的协议版本，使用Promise方式作为异步方法。
...@@ -2322,7 +2325,7 @@ getProtocol():Promise\<string> ...@@ -2322,7 +2325,7 @@ getProtocol():Promise\<string>
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | -------------- | -------------------- |
| Promise\<string> | 以Promise形式返回通信的协议。失败返回错误码，错误信息。 | | Promise\<string\> | 以Promise形式返回通信的协议。失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2344,7 +2347,7 @@ tls.getProtocol().then(data => { ...@@ -2344,7 +2347,7 @@ tls.getProtocol().then(data => {
### getCipherSuite<sup>9+</sup> ### getCipherSuite<sup>9+</sup>
getCipherSuite(callback: AsyncCallback\<Array\<string>>): void getCipherSuite(callback: AsyncCallback\<Array\<string\>\>): void
在TLSSocket通信连接成功之后，获取通信双方协商后的加密套件，使用callback方式作为异步方法。 在TLSSocket通信连接成功之后，获取通信双方协商后的加密套件，使用callback方式作为异步方法。
...@@ -2354,7 +2357,7 @@ getCipherSuite(callback: AsyncCallback\<Array\<string>>): void ...@@ -2354,7 +2357,7 @@ getCipherSuite(callback: AsyncCallback\<Array\<string>>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------| ---- | ---------------| | -------- | ----------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<Array\<string>> | 是 | 回调函数，返回通信双方支持的加密套件。 失败返回错误码，错误信息。 | | callback | AsyncCallback\<Array\<string\>\> | 是 | 回调函数，返回通信双方支持的加密套件。 失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2379,7 +2382,7 @@ tls.getCipherSuite((err, data) => { ...@@ -2379,7 +2382,7 @@ tls.getCipherSuite((err, data) => {
### getCipherSuite<sup>9+</sup> ### getCipherSuite<sup>9+</sup>
getCipherSuite(): Promise\<Array\<string>> getCipherSuite(): Promise\<Array\<string\>\>
在TLSSocket通信连接成功之后，获取通信双方协商后的加密套件，使用Promise方式作为异步方法。 在TLSSocket通信连接成功之后，获取通信双方协商后的加密套件，使用Promise方式作为异步方法。
...@@ -2389,7 +2392,7 @@ getCipherSuite(): Promise\<Array\<string>> ...@@ -2389,7 +2392,7 @@ getCipherSuite(): Promise\<Array\<string>>
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | --------------------- | | ---------------------- | --------------------- |
| Promise\<Array\<string>> | 以Promise形式返回通信双方支持的加密套件。失败返回错误码，错误信息。 | | Promise\<Array\<string\>\> | 以Promise形式返回通信双方支持的加密套件。失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2412,7 +2415,7 @@ tls.getCipherSuite().then(data => { ...@@ -2412,7 +2415,7 @@ tls.getCipherSuite().then(data => {
### getSignatureAlgorithms<sup>9+</sup> ### getSignatureAlgorithms<sup>9+</sup>
getSignatureAlgorithms(callback: AsyncCallback\<Array\<string>>): void getSignatureAlgorithms(callback: AsyncCallback\<Array\<string\>\>): void
在TLSSocket通信连接成功之后，获取通信双方协商后签名算法，该接口只适配双向认证模式下，使用callback方式作为异步方法。 在TLSSocket通信连接成功之后，获取通信双方协商后签名算法，该接口只适配双向认证模式下，使用callback方式作为异步方法。
...@@ -2422,7 +2425,7 @@ getSignatureAlgorithms(callback: AsyncCallback\<Array\<string>>): void ...@@ -2422,7 +2425,7 @@ getSignatureAlgorithms(callback: AsyncCallback\<Array\<string>>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------------------------------------| ---- | ---------------| | -------- | -------------------------------------| ---- | ---------------|
| callback | AsyncCallback\<Array\<string>> | 是 | 回调函数，返回双方支持的签名算法。 | | callback | AsyncCallback\<Array\<string\>\> | 是 | 回调函数，返回双方支持的签名算法。 |
**错误码：** **错误码：**
...@@ -2445,7 +2448,7 @@ tls.getSignatureAlgorithms((err, data) => { ...@@ -2445,7 +2448,7 @@ tls.getSignatureAlgorithms((err, data) => {
### getSignatureAlgorithms<sup>9+</sup> ### getSignatureAlgorithms<sup>9+</sup>
getSignatureAlgorithms(): Promise\<Array\<string>> getSignatureAlgorithms(): Promise\<Array\<string\>\>
在TLSSocket通信连接成功之后，获取通信双方协商后的签名算法，该接口只适配双向认证模式下，使用Promise方式作为异步方法。 在TLSSocket通信连接成功之后，获取通信双方协商后的签名算法，该接口只适配双向认证模式下，使用Promise方式作为异步方法。
...@@ -2455,7 +2458,7 @@ getSignatureAlgorithms(): Promise\<Array\<string>> ...@@ -2455,7 +2458,7 @@ getSignatureAlgorithms(): Promise\<Array\<string>>
| 类型 | 说明 | | 类型 | 说明 |
| ---------------------- | -------------------- | | ---------------------- | -------------------- |
| Promise\<Array\<string>> | 以Promise形式返回获取到的双方支持的签名算法。 | | Promise\<Array\<string\>\> | 以Promise形式返回获取到的双方支持的签名算法。 |
**错误码：** **错误码：**
...@@ -2476,7 +2479,7 @@ tls.getSignatureAlgorithms().then(data => { ...@@ -2476,7 +2479,7 @@ tls.getSignatureAlgorithms().then(data => {
### send<sup>9+</sup> ### send<sup>9+</sup>
send(data: string, callback: AsyncCallback\<void>): void send(data: string, callback: AsyncCallback\<void\>): void
在TLSSocket通信连接成功之后，向服务端发送消息，使用callback方式作为异步方法。 在TLSSocket通信连接成功之后，向服务端发送消息，使用callback方式作为异步方法。
...@@ -2487,7 +2490,7 @@ send(data: string, callback: AsyncCallback\<void>): void ...@@ -2487,7 +2490,7 @@ send(data: string, callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -----------------------------| ---- | ---------------| | -------- | -----------------------------| ---- | ---------------|
| data | string | 是 | 发送的数据内容。 | | data | string | 是 | 发送的数据内容。 |
| callback | AsyncCallback\<void> | 是 | 回调函数,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。 | | callback | AsyncCallback\<void\> | 是 | 回调函数,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2514,7 +2517,7 @@ tls.send("xxxx", (err) => { ...@@ -2514,7 +2517,7 @@ tls.send("xxxx", (err) => {
### send<sup>9+</sup> ### send<sup>9+</sup>
send(data: string): Promise\<void> send(data: string): Promise\<void\>
在TLSSocket通信连接成功之后，向服务端发送消息，使用Promise方式作为异步方法。 在TLSSocket通信连接成功之后，向服务端发送消息，使用Promise方式作为异步方法。
...@@ -2541,7 +2544,7 @@ send(data: string): Promise\<void> ...@@ -2541,7 +2544,7 @@ send(data: string): Promise\<void>
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | -------------- | -------------------- |
| Promise\<void> | 以Promise形式返回,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。 | | Promise\<void\> | 以Promise形式返回,返回TLSSocket发送数据的结果。失败返回错误码，错误信息。 |
**示例：** **示例：**
...@@ -2555,7 +2558,7 @@ tls.send("xxxx").then(() =>{ ...@@ -2555,7 +2558,7 @@ tls.send("xxxx").then(() =>{
### close<sup>9+</sup> ### close<sup>9+</sup>
close(callback: AsyncCallback\<void>): void close(callback: AsyncCallback\<void\>): void
在TLSSocket通信连接成功之后，断开连接，使用callback方式作为异步方法。 在TLSSocket通信连接成功之后，断开连接，使用callback方式作为异步方法。
...@@ -2565,7 +2568,7 @@ close(callback: AsyncCallback\<void>): void ...@@ -2565,7 +2568,7 @@ close(callback: AsyncCallback\<void>): void
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -----------------------------| ---- | ---------------| | -------- | -----------------------------| ---- | ---------------|
| callback | AsyncCallback\<void> | 是 | 回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码，错误信息。 | | callback | AsyncCallback\<void\> | 是 | 回调函数,成功返回TLSSocket关闭连接的结果。 失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2590,7 +2593,7 @@ tls.close((err) => { ...@@ -2590,7 +2593,7 @@ tls.close((err) => {
### close<sup>9+</sup> ### close<sup>9+</sup>
close(): Promise\<void> close(): Promise\<void\>
在TLSSocket通信连接成功之后，断开连接，使用Promise方式作为异步方法。 在TLSSocket通信连接成功之后，断开连接，使用Promise方式作为异步方法。
...@@ -2600,7 +2603,7 @@ close(): Promise\<void> ...@@ -2600,7 +2603,7 @@ close(): Promise\<void>
| 类型 | 说明 | | 类型 | 说明 |
| -------------- | -------------------- | | -------------- | -------------------- |
| Promise\<void> | 以Promise形式返回,返回TLSSocket关闭连接的结果。失败返回错误码，错误信息。 | | Promise\<void\> | 以Promise形式返回,返回TLSSocket关闭连接的结果。失败返回错误码，错误信息。 |
**错误码：** **错误码：**
...@@ -2631,7 +2634,7 @@ TLS连接的操作。 ...@@ -2631,7 +2634,7 @@ TLS连接的操作。
| -------------- | ------------------------------------- | --- |-------------- | | -------------- | ------------------------------------- | --- |-------------- |
| address | [NetAddress](#netaddress) | 是 | 网关地址。 | | address | [NetAddress](#netaddress) | 是 | 网关地址。 |
| secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。| | secureOptions | [TLSSecureOptions](#tlssecureoptions9) | 是 | TLS安全相关操作。|
| ALPNProtocols | Array\<string> | 否 | ALPN协议。 | | ALPNProtocols | Array\<string\> | 否 | ALPN协议。 |
## TLSSecureOptions<sup>9+</sup> ## TLSSecureOptions<sup>9+</sup>
...@@ -2641,11 +2644,11 @@ TLS安全相关操作，其中ca证书为必选参数，其他参数为可选参 ...@@ -2641,11 +2644,11 @@ TLS安全相关操作，其中ca证书为必选参数，其他参数为可选参
| 名称 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| --------------------- | ------------------------------------------------------ | --- |----------------------------------- | | --------------------- | ------------------------------------------------------ | --- |----------------------------------- |
| ca | string \| Array\<string> | 是 | 服务端的ca证书，用于认证校验服务端的数字证书。| | ca | string \| Array\<string\> | 是 | 服务端的ca证书，用于认证校验服务端的数字证书。|
| cert | string | 否 | 本地客户端的数字证书。 | | cert | string | 否 | 本地客户端的数字证书。 |
| key | string | 否 | 本地数字证书的私钥。 | | key | string | 否 | 本地数字证书的私钥。 |
| password | string | 否 | 读取私钥的密码。 | | password | string | 否 | 读取私钥的密码。 |
| protocols | [Protocol](#protocol9) \|Array\<[Protocol](#protocol9)> | 否 | TLS的协议版本。 | | protocols | [Protocol](#protocol9) \|Array\<[Protocol](#protocol9)\> | 否 | TLS的协议版本。 |
| useRemoteCipherPrefer | boolean | 否 | 优先使用对等方的密码套件。 | | useRemoteCipherPrefer | boolean | 否 | 优先使用对等方的密码套件。 |
| signatureAlgorithms | string | 否 | 通信过程中的签名算法。 | | signatureAlgorithms | string | 否 | 通信过程中的签名算法。 |
| cipherSuite | string | 否 | 通信过程中的加密套件。 | | cipherSuite | string | 否 | 通信过程中的加密套件。 |
......
zh-cn/application-dev/reference/apis/js-apis-system-fetch.md
浏览文件 @ 65460701
...@@ -14,7 +14,7 @@ import fetch from '@system.fetch'; ...@@ -14,7 +14,7 @@ import fetch from '@system.fetch';
``` ```
## fetch.fetch ## fetch.fetch<sup>3+</sup>
fetch(Object): void fetch(Object): void
...@@ -23,7 +23,7 @@ fetch(Object): void ...@@ -23,7 +23,7 @@ fetch(Object): void
**系统能力：** SystemCapability.Communication.NetStack **系统能力：** SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| url | string | 是 | 资源地址。 | | url | string | 是 | 资源地址。 |
| data | string \| Object | 否 | 请求的参数，可选类型是字符串或者json对象。详见表 data与Content-Type关系。 | | data | string \| Object | 否 | 请求的参数，可选类型是字符串或者json对象。详见表 data与Content-Type关系。 |
...@@ -45,7 +45,7 @@ fetch(Object): void ...@@ -45,7 +45,7 @@ fetch(Object): void
## FetchResponse ## FetchResponse
| 参数名 | 类型 | 可读 | 可写 | 说明 | | 名称 | 类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- | -------- |
| code | number | 是 | 否 | 表示服务器的状态code。 | | code | number | 是 | 否 | 表示服务器的状态code。 |
| data | string \| Object | 是 | 否 | 返回数据类型由responseType确定，详见表 responseType与success中data关系。 | | data | string \| Object | 是 | 否 | 返回数据类型由responseType确定，详见表 responseType与success中data关系。 |
......
zh-cn/application-dev/reference/apis/js-apis-system-network.md
浏览文件 @ 65460701
...@@ -31,7 +31,7 @@ getType(Object): void ...@@ -31,7 +31,7 @@ getType(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| success | Function | 否 | 接口调用成功的回调函数，返回值为[NetworkResponse](#networkresponse) | | success | Function | 否 | 接口调用成功的回调函数，返回值为[NetworkResponse](#networkresponse) |
| fail | Function | 否 | 接口调用失败的回调函数。 | | fail | Function | 否 | 接口调用失败的回调函数。 |
...@@ -71,7 +71,7 @@ subscribe(Object): void ...@@ -71,7 +71,7 @@ subscribe(Object): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| success | Function | 否 | 网络发生变化的回调函数，返回值为[NetworkResponse](#networkresponse) | | success | Function | 否 | 网络发生变化的回调函数，返回值为[NetworkResponse](#networkresponse) |
| fail | Function | 否 | 接口调用失败的回调函数。 | | fail | Function | 否 | 接口调用失败的回调函数。 |
...@@ -124,7 +124,7 @@ export default { ...@@ -124,7 +124,7 @@ export default {
**系统能力：** SystemCapability.Communication.NetManager.Core **系统能力：** SystemCapability.Communication.NetManager.Core
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
| metered | boolean | 否 |是否按照流量计费。 | | metered | boolean | 否 |是否按照流量计费。 |
| type | string | 是|网络类型，可能的值有2g，3g，4g，5g，wifi，none等。 | | type | string | 是|网络类型，可能的值有2g，3g，4g，5g，wifi，none等。 |
\ No newline at end of file
zh-cn/application-dev/reference/apis/js-apis-webSocket.md
浏览文件 @ 65460701
...@@ -64,7 +64,7 @@ ws.connect(defaultIpAddress, (err, value) => { ...@@ -64,7 +64,7 @@ ws.connect(defaultIpAddress, (err, value) => {
## webSocket.createWebSocket ## webSocket.createWebSocket
createWebSocket\(\): WebSocket createWebSocket(): WebSocket
创建一个WebSocket，里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。 创建一个WebSocket，里面包括建立连接、关闭连接、发送数据和订阅/取消订阅WebSocket连接的打开事件、接收到服务器消息事件、关闭事件和错误事件。
...@@ -89,7 +89,7 @@ let ws = webSocket.createWebSocket(); ...@@ -89,7 +89,7 @@ let ws = webSocket.createWebSocket();
### connect ### connect
connect\(url: string, callback: AsyncCallback<boolean\>\): void connect(url: string, callback: AsyncCallback\<boolean\>): void
根据URL地址，建立一个WebSocket连接，使用callback方式作为异步方法。 根据URL地址，建立一个WebSocket连接，使用callback方式作为异步方法。
...@@ -99,7 +99,7 @@ connect\(url: string, callback: AsyncCallback<boolean\>\): void ...@@ -99,7 +99,7 @@ connect\(url: string, callback: AsyncCallback<boolean\>\): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------------------------- | | -------- | ------------------------ | ---- | ---------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 | | url | string | 是 | 建立WebSocket连接的URL地址。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 | | callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
...@@ -128,7 +128,7 @@ ws.connect(url, (err, value) => { ...@@ -128,7 +128,7 @@ ws.connect(url, (err, value) => {
### connect ### connect
connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback<boolean\>\): void connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback\<boolean\>): void
根据URL地址和header，建立一个WebSocket连接，使用callback方式作为异步方法。 根据URL地址和header，建立一个WebSocket连接，使用callback方式作为异步方法。
...@@ -138,7 +138,7 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback< ...@@ -138,7 +138,7 @@ connect\(url: string, options: WebSocketRequestOptions, callback: AsyncCallback<
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------------------------------------------------- | | -------- | ------------------------ | ---- | ------------------------------------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 | | url | string | 是 | 建立WebSocket连接的URL地址。 |
| options | WebSocketRequestOptions | 是 | 参考[WebSocketRequestOptions](#websocketrequestoptions)。 | | options | WebSocketRequestOptions | 是 | 参考[WebSocketRequestOptions](#websocketrequestoptions)。 |
...@@ -173,7 +173,7 @@ ws.connect(url, { ...@@ -173,7 +173,7 @@ ws.connect(url, {
### connect ### connect
connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\> connect(url: string, options?: WebSocketRequestOptions): Promise\<boolean\>
根据URL地址和header，建立一个WebSocket连接，使用Promise方式作为异步方法。 根据URL地址和header，建立一个WebSocket连接，使用Promise方式作为异步方法。
...@@ -183,7 +183,7 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\> ...@@ -183,7 +183,7 @@ connect\(url: string, options?: WebSocketRequestOptions\): Promise<boolean\>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------- | ----------------------- | ---- | ------------------------------------------------------- | | ------- | ----------------------- | ---- | ------------------------------------------------------- |
| url | string | 是 | 建立WebSocket连接的URL地址。 | | url | string | 是 | 建立WebSocket连接的URL地址。 |
| options | WebSocketRequestOptions | 否 | 参考[WebSocketRequestOptions](#websocketrequestoptions)。 | | options | WebSocketRequestOptions | 否 | 参考[WebSocketRequestOptions](#websocketrequestoptions)。 |
...@@ -217,7 +217,7 @@ promise.then((value) => { ...@@ -217,7 +217,7 @@ promise.then((value) => {
### send ### send
send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void send(data: string | ArrayBuffer, callback: AsyncCallback\<boolean\>): void
通过WebSocket连接发送数据，使用callback方式作为异步方法。 通过WebSocket连接发送数据，使用callback方式作为异步方法。
...@@ -227,9 +227,9 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void ...@@ -227,9 +227,9 @@ send\(data: string | ArrayBuffer, callback: AsyncCallback<boolean\>\): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ------------ | | -------- | ------------------------ | ---- | ------------ |
| data | string \| ArrayBuffer <sup>8+</sup> | 是 | 发送的数据。 | | data | string \| ArrayBuffer | 是 | 发送的数据。<br>API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 | | callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
**错误码：** **错误码：**
...@@ -258,7 +258,7 @@ ws.connect(url, (err, value) => { ...@@ -258,7 +258,7 @@ ws.connect(url, (err, value) => {
### send ### send
send\(data: string | ArrayBuffer\): Promise<boolean\> send(data: string | ArrayBuffer): Promise\<boolean\>
通过WebSocket连接发送数据，使用Promise方式作为异步方法。 通过WebSocket连接发送数据，使用Promise方式作为异步方法。
...@@ -268,9 +268,9 @@ send\(data: string | ArrayBuffer\): Promise<boolean\> ...@@ -268,9 +268,9 @@ send\(data: string | ArrayBuffer\): Promise<boolean\>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------ | ------ | ---- | ------------ | | ------ | ------ | ---- | ------------ |
| data | string \| ArrayBuffer <sup>8+</sup> | 是 | 发送的数据。 | | data | string \| ArrayBuffer | 是 | 发送的数据。<br>API 6及更早版本仅支持string类型。API 8起同时支持string和ArrayBuffer类型。 |
**返回值：** **返回值：**
...@@ -303,7 +303,7 @@ ws.connect(url, (err, value) => { ...@@ -303,7 +303,7 @@ ws.connect(url, (err, value) => {
### close ### close
close\(callback: AsyncCallback<boolean\>\): void close(callback: AsyncCallback\<boolean\>): void
关闭WebSocket连接，使用callback方式作为异步方法。 关闭WebSocket连接，使用callback方式作为异步方法。
...@@ -313,7 +313,7 @@ close\(callback: AsyncCallback<boolean\>\): void ...@@ -313,7 +313,7 @@ close\(callback: AsyncCallback<boolean\>\): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ---------- | | -------- | ------------------------ | ---- | ---------- |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 | | callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
...@@ -341,7 +341,7 @@ ws.close((err, value) => { ...@@ -341,7 +341,7 @@ ws.close((err, value) => {
### close ### close
close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void close(options: WebSocketCloseOptions, callback: AsyncCallback\<boolean\>): void
根据可选参数code和reason，关闭WebSocket连接，使用callback方式作为异步方法。 根据可选参数code和reason，关闭WebSocket连接，使用callback方式作为异步方法。
...@@ -351,7 +351,7 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void ...@@ -351,7 +351,7 @@ close\(options: WebSocketCloseOptions, callback: AsyncCallback<boolean\>\): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------------------ | ---- | ----------------------------------------------------- | | -------- | ------------------------ | ---- | ----------------------------------------------------- |
| options | WebSocketCloseOptions | 是 | 参考[WebSocketCloseOptions](#websocketcloseoptions)。 | | options | WebSocketCloseOptions | 是 | 参考[WebSocketCloseOptions](#websocketcloseoptions)。 |
| callback | AsyncCallback\<boolean\> | 是 | 回调函数。 | | callback | AsyncCallback\<boolean\> | 是 | 回调函数。 |
...@@ -383,7 +383,7 @@ ws.close({ ...@@ -383,7 +383,7 @@ ws.close({
### close ### close
close\(options?: WebSocketCloseOptions\): Promise<boolean\> close(options?: WebSocketCloseOptions): Promise\<boolean\>
根据可选参数code和reason，关闭WebSocket连接，使用Promise方式作为异步方法。 根据可选参数code和reason，关闭WebSocket连接，使用Promise方式作为异步方法。
...@@ -393,7 +393,7 @@ close\(options?: WebSocketCloseOptions\): Promise<boolean\> ...@@ -393,7 +393,7 @@ close\(options?: WebSocketCloseOptions\): Promise<boolean\>
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| ------- | --------------------- | ---- | ----------------------------------------------------- | | ------- | --------------------- | ---- | ----------------------------------------------------- |
| options | WebSocketCloseOptions | 否 | 参考[WebSocketCloseOptions](#websocketcloseoptions)。 | | options | WebSocketCloseOptions | 否 | 参考[WebSocketCloseOptions](#websocketcloseoptions)。 |
...@@ -427,9 +427,9 @@ promise.then((value) => { ...@@ -427,9 +427,9 @@ promise.then((value) => {
``` ```
### on\('open'\) ### on('open')
on\(type: 'open', callback: AsyncCallback<Object\>\): void on(type: 'open', callback: AsyncCallback\<Object\>): void
订阅WebSocket的打开事件，使用callback方式作为异步方法。 订阅WebSocket的打开事件，使用callback方式作为异步方法。
...@@ -437,7 +437,7 @@ on\(type: 'open', callback: AsyncCallback<Object\>\): void ...@@ -437,7 +437,7 @@ on\(type: 'open', callback: AsyncCallback<Object\>\): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ----------------------------- | | -------- | ----------------------- | ---- | ----------------------------- |
| type | string | 是 | 'open'：WebSocket的打开事件。 | | type | string | 是 | 'open'：WebSocket的打开事件。 |
| callback | AsyncCallback\<Object\> | 是 | 回调函数。 | | callback | AsyncCallback\<Object\> | 是 | 回调函数。 |
...@@ -453,9 +453,9 @@ ws.on('open', (err, value) => { ...@@ -453,9 +453,9 @@ ws.on('open', (err, value) => {
``` ```
### off\('open'\) ### off('open')
off\(type: 'open', callback?: AsyncCallback<Object\>\): void off(type: 'open', callback?: AsyncCallback\<Object\>): void
取消订阅WebSocket的打开事件，使用callback方式作为异步方法。 取消订阅WebSocket的打开事件，使用callback方式作为异步方法。
...@@ -466,7 +466,7 @@ off\(type: 'open', callback?: AsyncCallback<Object\>\): void ...@@ -466,7 +466,7 @@ off\(type: 'open', callback?: AsyncCallback<Object\>\): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | ----------------------------- | | -------- | ----------------------- | ---- | ----------------------------- |
| type | string | 是 | 'open'：WebSocket的打开事件。 | | type | string | 是 | 'open'：WebSocket的打开事件。 |
| callback | AsyncCallback\<Object\> | 否 | 回调函数。 | | callback | AsyncCallback\<Object\> | 否 | 回调函数。 |
...@@ -484,20 +484,20 @@ ws.off('open', callback1); ...@@ -484,20 +484,20 @@ ws.off('open', callback1);
``` ```
### on\('message'\) ### on('message')
on\(type: 'message', callback: AsyncCallback<string | ArrayBuffer\>\): void on(type: 'message', callback: AsyncCallback\<string | ArrayBuffer\>): void
订阅WebSocket的接收到服务器消息事件，使用callback方式作为异步方法。每个消息最大长度为4K，超过4K自动分片。 订阅WebSocket的接收到服务器消息事件，使用callback方式作为异步方法。每个消息最大长度为4K，超过4K自动分片。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。 >AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。
**系统能力**：SystemCapability.Communication.NetStack **系统能力**：SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------- | ---- | -------------------------------------------- | | -------- | ----------------------- | ---- | -------------------------------------------- |
| type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 | | type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 |
| callback | AsyncCallback\<string \| ArrayBuffer <sup>8+</sup>\> | 是 | 回调函数。 | | callback | AsyncCallback\<string \| ArrayBuffer <sup>8+</sup>\> | 是 | 回调函数。 |
...@@ -512,21 +512,21 @@ ws.on('message', (err, value) => { ...@@ -512,21 +512,21 @@ ws.on('message', (err, value) => {
``` ```
### off\('message'\) ### off('message')
off\(type: 'message', callback?: AsyncCallback<string | ArrayBuffer\>\): void off(type: 'message', callback?: AsyncCallback\<string | ArrayBuffer\>): void
取消订阅WebSocket的接收到服务器消息事件，使用callback方式作为异步方法。每个消息最大长度为4K，超过4K自动分片。 取消订阅WebSocket的接收到服务器消息事件，使用callback方式作为异步方法。每个消息最大长度为4K，超过4K自动分片。
>![](public_sys-resources/icon-note.gif) **说明：** >![](public_sys-resources/icon-note.gif) **说明：**
>AsyncCallback中的数据可以是字符串\(API 6\)或ArrayBuffer\(API 8\)。 >AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。
>可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。 >可以指定传入on中的callback取消一个订阅，也可以不指定callback清空所有订阅。
**系统能力**：SystemCapability.Communication.NetStack **系统能力**：SystemCapability.Communication.NetStack
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | --------------------------------------------------- | ---- | -------------------------------------------- | | -------- | --------------------------------------------------- | ---- | -------------------------------------------- |
| type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 | | type | string | 是 | 'message'：WebSocket的接收到服务器消息事件。 |
| callback | AsyncCallback\<string \|ArrayBuffer <sup>8+</sup>\> | 否 | 回调函数。 | | callback | AsyncCallback\<string \|ArrayBuffer <sup>8+</sup>\> | 否 | 回调函数。 |
...@@ -539,9 +539,9 @@ ws.off('message'); ...@@ -539,9 +539,9 @@ ws.off('message');
``` ```
### on\('close'\) ### on('close')
on\(type: 'close', callback: AsyncCallback<\{ code: number, reason: string \}\>\): void on(type: 'close', callback: AsyncCallback\<{ code: number, reason: string }\>): void
订阅WebSocket的关闭事件，使用callback方式作为异步方法。 订阅WebSocket的关闭事件，使用callback方式作为异步方法。
...@@ -549,10 +549,10 @@ on\(type: 'close', callback: AsyncCallback<\{ code: number, reason: string \}\>\ ...@@ -549,10 +549,10 @@ on\(type: 'close', callback: AsyncCallback<\{ code: number, reason: string \}\>\
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ | | -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close'：WebSocket的关闭事件。 | | type | string | 是 | 'close'：WebSocket的关闭事件。 |
| callback | AsyncCallback<{ code: number, reason: string }> | 是 | 回调函数。 | | callback | AsyncCallback\<{ code: number, reason: string }\> | 是 | 回调函数。<br>close：close错误码，reason：错误码说明 |
**示例：** **示例：**
...@@ -564,9 +564,9 @@ ws.on('close', (err, value) => { ...@@ -564,9 +564,9 @@ ws.on('close', (err, value) => {
``` ```
### off\('close'\) ### off('close')
off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\>\): void off(type: 'close', callback?: AsyncCallback\<{ code: number, reason: string }\>): void
取消订阅WebSocket的关闭事件，使用callback方式作为异步方法。 取消订阅WebSocket的关闭事件，使用callback方式作为异步方法。
...@@ -577,10 +577,10 @@ off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\ ...@@ -577,10 +577,10 @@ off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ----------------------------------------------- | ---- | ------------------------------ | | -------- | ----------------------------------------------- | ---- | ------------------------------ |
| type | string | 是 | 'close'：WebSocket的关闭事件。 | | type | string | 是 | 'close'：WebSocket的关闭事件。 |
| callback | AsyncCallback<{ code: number, reason: string }> | 否 | 回调函数。 | | callback | AsyncCallback\<{ code: number, reason: string }\> | 否 | 回调函数。<br>close：close错误码，reason：错误码说明 |
**示例：** **示例：**
...@@ -590,9 +590,9 @@ ws.off('close'); ...@@ -590,9 +590,9 @@ ws.off('close');
``` ```
### on\('error'\) ### on('error')
on\(type: 'error', callback: ErrorCallback\): void on(type: 'error', callback: ErrorCallback): void
订阅WebSocket的Error事件，使用callback方式作为异步方法。 订阅WebSocket的Error事件，使用callback方式作为异步方法。
...@@ -600,7 +600,7 @@ on\(type: 'error', callback: ErrorCallback\): void ...@@ -600,7 +600,7 @@ on\(type: 'error', callback: ErrorCallback\): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------- | | -------- | ------------- | ---- | ------------------------------- |
| type | string | 是 | 'error'：WebSocket的Error事件。 | | type | string | 是 | 'error'：WebSocket的Error事件。 |
| callback | ErrorCallback | 是 | 回调函数。 | | callback | ErrorCallback | 是 | 回调函数。 |
...@@ -615,9 +615,9 @@ ws.on('error', (err) => { ...@@ -615,9 +615,9 @@ ws.on('error', (err) => {
``` ```
### off\('error'\) ### off('error')
off\(type: 'error', callback?: ErrorCallback\): void off(type: 'error', callback?: ErrorCallback): void
取消订阅WebSocket的Error事件，使用callback方式作为异步方法。 取消订阅WebSocket的Error事件，使用callback方式作为异步方法。
...@@ -628,7 +628,7 @@ off\(type: 'error', callback?: ErrorCallback\): void ...@@ -628,7 +628,7 @@ off\(type: 'error', callback?: ErrorCallback\): void
**参数：** **参数：**
| 参数名 | 类型 | 必填 | 说明 | | 名称 | 类型 | 必填 | 说明 |
| -------- | ------------- | ---- | ------------------------------- | | -------- | ------------- | ---- | ------------------------------- |
| type | string | 是 | 'error'：WebSocket的Error事件。 | | type | string | 是 | 'error'：WebSocket的Error事件。 |
| callback | ErrorCallback | 否 | 回调函数。 | | callback | ErrorCallback | 否 | 回调函数。 |
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或