提交 e9846da2 编写于 作者: Y Yangys

Network management modify and update

Signed-off-by: NYangys <yangyousheng@huawei.com>
上级 9a631800
......@@ -406,7 +406,7 @@ off\(type: 'open', callback?: AsyncCallback<Object\>\): void
Disables listening for the **open** events of a WebSocket connection. This API uses an asynchronous callback to return the result.
>![](public_sys-resources/icon-note.gif) **NOTE:**
>**NOTE:**
>You can pass the callback of the **on** function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events.
**System capability**: SystemCapability.Communication.NetStack
......@@ -437,7 +437,7 @@ on\(type: 'message', callback: AsyncCallback<string | ArrayBuffer\>\): void
Enables listening for the **message** events of a WebSocket connection. This API uses an asynchronous callback to return the result. The maximum length of each message is 4 KB. If the length exceeds 4 KB, the message is automatically fragmented.
>![](public_sys-resources/icon-note.gif) **NOTE:**
>**NOTE:**
>The data in **AsyncCallback** can be in the format of string\(API 6\) or ArrayBuffer\(API 8\).
**System capability**: SystemCapability.Communication.NetStack
......@@ -466,7 +466,7 @@ off\(type: 'message', callback?: AsyncCallback<string | ArrayBuffer\>\): void
Disables listening for the **message** events of a WebSocket connection. This API uses an asynchronous callback to return the result. The maximum length of each message is 4 KB. If the length exceeds 4 KB, the message is automatically fragmented.
>![](public_sys-resources/icon-note.gif) **NOTE:**
>**NOTE:**
>The data in **AsyncCallback** can be in the format of string\(API 6\) or ArrayBuffer\(API 8\).
>You can pass the callback of the **on** function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events.
......@@ -518,7 +518,7 @@ off\(type: 'close', callback?: AsyncCallback<\{ code: number, reason: string \}\
Disables listening for the **close** events of a WebSocket connection. This API uses an asynchronous callback to return the result.
>![](public_sys-resources/icon-note.gif) **NOTE:**
>**NOTE:**
>You can pass the callback of the **on** function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events.
**System capability**: SystemCapability.Communication.NetStack
......@@ -571,7 +571,7 @@ off\(type: 'error', callback?: ErrorCallback\): void
Disables listening for the **error** events of a WebSocket connection. This API uses an asynchronous callback to return the result.
>![](public_sys-resources/icon-note.gif) **NOTE:**
>**NOTE:**
>You can pass the callback of the **on** function if you want to cancel listening for a certain type of event. If you do not pass the callback, you will cancel listening for all events.
**System capability**: SystemCapability.Communication.NetStack
......
......@@ -26,7 +26,7 @@ Your feedback matters. Submit issues and leave as detailed information as possib
1. On the Gitee page, click the **Issues** tab. On the displayed page, click **New issue**. Then enter the issue title and issue details.
2. Click **New** to submit the issue. The Docs team will confirm the issue.
>![](public_sys-resources/icon-note.gif) **NOTE**
>**NOTE**
>
>**How can I provide a high-quality issue?**
>
......
......@@ -69,7 +69,7 @@ Use relative paths to reference pictures in the document.
- The text on pictures should be Chinese in Chinese documents and English in English documents.
- It is recommended that pictures be named based on the content. Using only a number is difficult for picture inheritance.
>![](public_sys-resources/icon-note.gif) **NOTE:**
>**NOTE:**
>Reference:
>!\[\]\(./pic/pic-standard.png\)
......
......@@ -195,7 +195,7 @@ The HCTest framework is used to support test cases developed with the C language
Test suites are built along with version build. The ACTS is built together with the debug version.
>![](public_sys-resources/icon-note.gif) **NOTE**
>**NOTE**
>
>The ACTS build middleware is a static library, which will be linked to the image.
......@@ -334,7 +334,7 @@ The HCPPTest framework is enhanced and adapted based on the open-source framewor
Test suites are built along with the version build. The ACTS is built together with the debug version.
>![](public_sys-resources/icon-note.gif) **NOTE**
>**NOTE**
>
>The ACTS for the small system is independently built to an executable file \(.bin\) and archived in the **suites\\acts** directory of the build result.
......
......@@ -63,7 +63,7 @@
});
// 调用startSharing方法,来开启指定类型共享
sharing.startSharing(SharingIfaceType.SHARING_WIFI, (error) => {
sharing.startSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => {
console.log(JSON.stringify(error));
});
```
......@@ -88,7 +88,7 @@
});
// 调用stopSharing方法,来停止指定类型共享
sharing.stopSharing(SharingIfaceType.SHARING_WIFI, (error) => {
sharing.stopSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => {
console.log(JSON.stringify(error));
});
```
......@@ -107,7 +107,7 @@
import sharing from '@ohos.net.sharing'
// 调用startSharing方法,来开启指定类型共享
sharing.startSharing(SharingIfaceType.SHARING_WIFI, (error) => {
sharing.startSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => {
console.log(JSON.stringify(error));
});
......@@ -118,7 +118,7 @@
});
// 调用stopSharing方法,来停止指定类型共享,共享网络数据量清零
sharing.stopSharing(SharingIfaceType.SHARING_WIFI, (error) => {
sharing.stopSharing(sharing.SharingIfaceType.SHARING_WIFI, (error) => {
console.log(JSON.stringify(error));
});
......
......@@ -190,7 +190,7 @@ UDP与TCP流程大体类似,下面以TCP为例:
let tlsTwoWay = socket.constructTLSSocketInstance();
// 订阅TLS Socket相关的订阅事件
tcp.on('message', value => {
tlsTwoWay.on('message', value => {
console.log("on message")
let buffer = value.message
let dataView = new DataView(buffer)
......@@ -200,10 +200,10 @@ UDP与TCP流程大体类似,下面以TCP为例:
}
console.log("on connect received:" + str)
});
tcp.on('connect', () => {
tlsTwoWay.on('connect', () => {
console.log("on connect")
});
tcp.on('close', () => {
tlsTwoWay.on('close', () => {
console.log("on close")
});
......@@ -247,22 +247,22 @@ UDP与TCP流程大体类似,下面以TCP为例:
});
// 连接使用完毕后,主动关闭。取消相关事件的订阅。
tls.close((err) => {
tlsTwoWay.close((err) => {
if (err) {
console.log("close callback error = " + err);
} else {
console.log("close success");
}
tls.off('message');
tls.off('connect');
tls.off('close');
tlsTwoWay.off('message');
tlsTwoWay.off('connect');
tlsTwoWay.off('close');
});
// 创建一个(单向认证)TLS Socket连接,返回一个TLS Socket对象。
let tlsOneWay = socket.constructTLSSocketInstance(); // One way authentication
// 订阅TLS Socket相关的订阅事件
tcp.on('message', value => {
tlsTwoWay.on('message', value => {
console.log("on message")
let buffer = value.message
let dataView = new DataView(buffer)
......@@ -272,10 +272,10 @@ UDP与TCP流程大体类似,下面以TCP为例:
}
console.log("on connect received:" + str)
});
tcp.on('connect', () => {
tlsTwoWay.on('connect', () => {
console.log("on connect")
});
tcp.on('close', () => {
tlsTwoWay.on('close', () => {
console.log("on close")
});
......@@ -308,15 +308,15 @@ UDP与TCP流程大体类似,下面以TCP为例:
});
// 连接使用完毕后,主动关闭。取消相关事件的订阅。
tls.close((err) => {
tlsTwoWay.close((err) => {
if (err) {
console.log("close callback error = " + err);
} else {
console.log("close success");
}
tls.off('message');
tls.off('connect');
tls.off('close');
tlsTwoWay.off('message');
tlsTwoWay.off('connect');
tlsTwoWay.off('close');
});
```
......
......@@ -77,7 +77,7 @@ createHttp(): HttpRequest
| 类型 | 说明 |
| :---------- | :----------------------------------------------------------- |
| HttpRequest | 返回一个HttpRequest对象,里面包括request、destroy、on和off方法。 |
| HttpRequest | 返回一个HttpRequest对象,里面包括request、request2、destroy、on和off方法。 |
**示例:**
......@@ -96,6 +96,9 @@ request(url: string, callback: AsyncCallback\<HttpResponse\>):void
根据URL地址,发起HTTP网络请求,使用callback方式作为异步方法。
>**说明:**
>此接口仅支持数据大小为5M以内的数据传输。
**需要权限**:ohos.permission.INTERNET
**系统能力**:SystemCapability.Communication.NetStack
......@@ -144,6 +147,9 @@ request(url: string, options: HttpRequestOptions, callback: AsyncCallback\<HttpR
根据URL地址和相关配置项,发起HTTP网络请求,使用callback方式作为异步方法。
>**说明:**
>此接口仅支持数据大小为5M以内的数据传输。
**需要权限**:ohos.permission.INTERNET
**系统能力**:SystemCapability.Communication.NetStack
......@@ -227,6 +233,9 @@ request(url: string, options? : HttpRequestOptions): Promise\<HttpResponse\>
根据URL地址,发起HTTP网络请求,使用Promise方式作为异步方法。
>**说明:**
>此接口仅支持数据大小为5M以内的数据传输。
**需要权限**:ohos.permission.INTERNET
**系统能力**:SystemCapability.Communication.NetStack
......@@ -530,7 +539,7 @@ on(type: 'headerReceive', callback: AsyncCallback\<Object\>): void
订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>此接口已废弃,建议使用[on('headersReceive')<sup>8+</sup>](#onheadersreceive8)替代。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -545,12 +554,8 @@ on(type: 'headerReceive', callback: AsyncCallback\<Object\>): void
**示例:**
```js
httpRequest.on('headerReceive', (err, data) => {
if (!err) {
console.info('header: ' + JSON.stringify(data));
} else {
console.info('error:' + JSON.stringify(err));
}
httpRequest.on('headerReceive', (data) => {
console.info('error:' + JSON.stringify(data));
});
```
......@@ -560,7 +565,7 @@ off(type: 'headerReceive', callback?: AsyncCallback\<Object\>): void
取消订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>
>1. 此接口已废弃,建议使用[off('headersReceive')<sup>8+</sup>](#offheadersreceive8)替代。
>
......@@ -610,7 +615,7 @@ off(type: 'headersReceive', callback?: Callback\<Object\>): void
取消订阅HTTP Response Header 事件。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -679,7 +684,7 @@ off(type: 'dataReceive', callback?: Callback\<ArrayBuffer\>): void
取消订阅HTTP流式响应数据接收事件。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -726,7 +731,7 @@ off(type: 'dataEnd', callback?: Callback\<void\>): void
取消订阅HTTP流式响应数据接收完毕事件。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -763,9 +768,7 @@ httpRequest.off('dataEnd');
```js
httpRequest.on('dataProgress', (data) => {
if (!err) {
console.info('dataProgress:' + JSON.stringify(data));
}
console.info('dataProgress:' + JSON.stringify(data));
});
```
......@@ -775,7 +778,7 @@ off(type: 'dataProgress', callback?: Callback\<{ receiveSize: number, totalSize:
取消订阅HTTP流式响应数据接收进度事件。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -915,7 +918,7 @@ let httpResponseCache = http.createHttpResponseCache();
## HttpResponseCache<sup>9+</sup>
存储HTTP访问请求响应的对象。
存储HTTP访问请求响应的对象。在调用HttpResponseCache的方法前,需要先通过[createHttpResponseCache()](#httpcreatehttpresponsecache9)创建一个任务。
### flush<sup>9+</sup>
......
# @ohos.net.socket (Socket连接)
本模块提供利用Socket进行数据传输的能力,支持TCPSocket、UDPSocket、WebSocket和TLSSocket。
> **说明:**
>
> 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。
......@@ -279,7 +281,7 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void
获取UDPSocket状态。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -325,7 +327,7 @@ getState(): Promise\<SocketStateBase\>
获取UDPSocket状态。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -364,7 +366,7 @@ setExtraOptions(options: UDPExtraOptions, callback: AsyncCallback\<void\>): void
设置UDPSocket连接的其他属性。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -418,7 +420,7 @@ setExtraOptions(options: UDPExtraOptions): Promise\<void\>
设置UDPSocket连接的其他属性。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -500,7 +502,7 @@ off(type: 'message', callback?: Callback\<{message: ArrayBuffer, remoteInfo: Soc
取消订阅UDPSocket连接的接收消息事件。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -560,7 +562,7 @@ off(type: 'listening' | 'close', callback?: Callback\<void\>): void
取消订阅UDPSocket连接的数据包消息事件或关闭事件。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -624,7 +626,7 @@ off(type: 'error', callback?: ErrorCallback): void
取消订阅UDPSocket连接的error事件。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -829,7 +831,7 @@ connect(options: TCPConnectOptions, callback: AsyncCallback\<void\>): void
连接到指定的IP地址和端口。使用callback方法作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -912,7 +914,7 @@ send(options: TCPSendOptions, callback: AsyncCallback\<void\>): void
通过TCPSocket连接发送数据。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>connect方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -961,7 +963,7 @@ send(options: TCPSendOptions): Promise\<void\>
通过TCPSocket连接发送数据。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>connect方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -1085,7 +1087,7 @@ getRemoteAddress(callback: AsyncCallback\<NetAddress\>): void
获取对端Socket地址。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>connect方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -1130,7 +1132,7 @@ getRemoteAddress(): Promise\<NetAddress\>
获取对端Socket地址。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>connect方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -1174,7 +1176,7 @@ getState(callback: AsyncCallback\<SocketStateBase\>): void
获取TCPSocket状态。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind或connect方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -1219,7 +1221,7 @@ getState(): Promise\<SocketStateBase\>
获取TCPSocket状态。使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind或connect方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -1263,7 +1265,7 @@ setExtraOptions(options: TCPExtraOptions, callback: AsyncCallback\<void\>): void
设置TCPSocket连接的其他属性。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind或connect方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -1319,7 +1321,7 @@ setExtraOptions(options: TCPExtraOptions): Promise\<void\>
设置TCPSocket连接的其他属性,使用Promise方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>bind或connect方法调用成功后,才可调用此方法。
**需要权限**:ohos.permission.INTERNET
......@@ -1404,7 +1406,7 @@ off(type: 'message', callback?: Callback<{message: ArrayBuffer, remoteInfo: Sock
取消订阅TCPSocket连接的接收消息事件。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -1464,7 +1466,7 @@ off(type: 'connect' | 'close', callback?: Callback\<void\>): void
取消订阅TCPSocket的连接事件或关闭事件。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -1528,7 +1530,7 @@ off(type: 'error', callback?: ErrorCallback): void
取消订阅TCPSocket连接的error事件。使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......
......@@ -459,7 +459,7 @@ off(type: 'open', callback?: AsyncCallback\<Object\>): void
取消订阅WebSocket的打开事件,使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -490,7 +490,7 @@ on(type: 'message', callback: AsyncCallback\<string | ArrayBuffer\>): void
订阅WebSocket的接收到服务器消息事件,使用callback方式作为异步方法。每个消息最大长度为4K,超过4K自动分片。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -518,7 +518,7 @@ off(type: 'message', callback?: AsyncCallback\<string | ArrayBuffer\>): void
取消订阅WebSocket的接收到服务器消息事件,使用callback方式作为异步方法。每个消息最大长度为4K,超过4K自动分片。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>AsyncCallback中的数据可以是字符串(API 6)或ArrayBuffer(API 8)。
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
......@@ -570,7 +570,7 @@ off(type: 'close', callback?: AsyncCallback\<{ code: number, reason: string }\>)
取消订阅WebSocket的关闭事件,使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......@@ -621,7 +621,7 @@ off(type: 'error', callback?: ErrorCallback): void
取消订阅WebSocket的Error事件,使用callback方式作为异步方法。
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>可以指定传入on中的callback取消一个订阅,也可以不指定callback清空所有订阅。
**系统能力**:SystemCapability.Communication.NetStack
......
......@@ -67,7 +67,7 @@
- 中文用中文图,英文用英文图形。
- 图片建议根据内容命名,只用数字序列不利于后续图片的继承。
>![](public_sys-resources/icon-note.gif) **说明**:
>**说明**:
>引用方式:
>!\[\]\(./pic/pic-standard.png\)
......
......@@ -26,7 +26,7 @@
1. 在Gitee页面中,“Issue”页签中单击“新建Issue”,在标题栏中描述问题,在编辑框中添加详细问题描述。
2. 单击“创建”按钮,提交Issue,耐心等待文档团队成员确认您的问题。
>![](public_sys-resources/icon-note.gif) **说明**:
>**说明**:
>**如何反馈一个高质量的问题**?
>
>- 提供问题的清晰描述,描述具体缺失、过时、错误的内容或者需要改进的文字。
......
......@@ -347,7 +347,7 @@ OpenHarmony支持如下几种系统类型:
随版本编译,debug版本编译时会同步编译acts测试套件
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>acts测试套件编译中间件为静态库,最终链接到版本镜像中 。
......@@ -480,7 +480,7 @@ OpenHarmony支持如下几种系统类型:
随版本编译,debug版本编译时会同步编译acts测试套件
>![](public_sys-resources/icon-note.gif) **说明:**
>**说明:**
>小型系统acts独立编译成可执行文件(bin格式), 在编译产物的suites\\acts目录下归档。
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册