From 4efaacd9cba3af1fc919a214b1b6d5cb11f0620e Mon Sep 17 00:00:00 2001 From: Yangys Date: Thu, 13 Apr 2023 11:36:38 +0800 Subject: [PATCH] Websocket Modify and Ethernet new Interface Signed-off-by: Yangys --- .../connectivity/net-ethernet.md | 24 +++++++ .../reference/apis/js-apis-http.md | 2 +- .../reference/apis/js-apis-net-ethernet.md | 68 +++++++++++++++++++ .../reference/apis/js-apis-webSocket.md | 11 ++- 4 files changed, 103 insertions(+), 2 deletions(-) diff --git a/zh-cn/application-dev/connectivity/net-ethernet.md b/zh-cn/application-dev/connectivity/net-ethernet.md index 5a32464692..808aaef00e 100644 --- a/zh-cn/application-dev/connectivity/net-ethernet.md +++ b/zh-cn/application-dev/connectivity/net-ethernet.md @@ -28,6 +28,8 @@ | ohos.net.ethernet | function getIfaceConfig(iface: string, callback: AsyncCallback\): void | 获取指定以太网的网络属性，iface为网口名称，调用callback | | ohos.net.ethernet | function isIfaceActive(iface: string, callback: AsyncCallback\): void | 判断指定网口是否已激活，iface为网卡名称（无参为是否有激活网口），调用callback | | ohos.net.ethernet | function getAllActiveIfaces(callback: AsyncCallback\>): void; | 获取所有活动的网络接口，调用callback | +| ohos.net.ethernet | function on(type: 'interfaceStateChange', callback: Callback\<{ iface: string, active: boolean }\>): void; | 注册网络接口监听函数 | +| ohos.net.ethernet | function off(type: 'interfaceStateChange', callback?: Callback\<{ iface: string, active: boolean }\>): void; | 解除注册网络接口监听函数 | ## 以太网连接-DHCP模式 @@ -138,3 +140,25 @@ } }); ``` + +## 监听网络设备接口状态变化 + +### 开发步骤 + +1. 从@ohos.net.ethernet中导入ethernet命名空间。 +2. 调用该对象的on()方法，订阅interfaceStateChange事件。可以根据业务需要订阅此消息。 +3. 订阅interfaceStateChange事件后，回调函数会在网卡设备的接口状态发生变化时触发。 +4. 调用该对象的off()方法，取消订阅interfaceStateChange事件。 + +```js + // 从@ohos.net.ethernet中导入ethernet命名空间 + import ethernet from '@ohos.net.ethernet' + + // 订阅interfaceStateChange事件 + ethernet.on('interfaceStateChange', ((data) => { + console.log(JSON.stringify(data)); + })); + + // 取消事件订阅 + ethernet.off('interfaceStateChange'); +``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-http.md b/zh-cn/application-dev/reference/apis/js-apis-http.md index 99d0e7d63c..b2087c19a1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-http.md +++ b/zh-cn/application-dev/reference/apis/js-apis-http.md @@ -334,7 +334,7 @@ httpRequest.destroy(); request2(url: string, callback: AsyncCallback\): void -根据URL地址和相关配置项，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。 +根据URL地址，发起HTTP网络请求并返回流式响应，使用callback方式作为异步方法。 **需要权限**：ohos.permission.INTERNET diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md b/zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md index 982f8ac051..ab8f992ba9 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-ethernet.md @@ -386,6 +386,74 @@ ethernet.getAllActiveIfaces().then((data) => { }); ``` +## sharing.on('interfaceStateChange')10+ + +on(type: 'interfaceStateChange', callback: Callback\<{ iface: string, active: boolean }\>): void + +注册网卡热插拔事件，使用callback方式作为异步方法。 + +**系统接口**：此接口为系统接口。 + +**需要权限**：ohos.permission.GET_NETWORK_INFO + +**系统能力**：SystemCapability.Communication.NetManager.Ethernet + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ---------- | +| type | string | 是 | 订阅的事件类型，'interfaceStateChange'。 | +| callback | AsyncCallback\<{ iface: string, active: boolean }\> | 是 | 回调函数。
iface：网卡名称。
active：是否处于激活状态（true：激活；false：未激活） | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Applicable only to system applications. | +| 401 | Parameter error. | + +**示例：** + +```js + ethernet.on('interfaceStateChange', (data) => { + console.log('on interfaceSharingStateChange：' + JSON.stringify(data)); +}); +``` + +## ethernet.off('interfaceStateChange')10+ + +off(type: 'interfaceStateChange', callback?: Callback\<{ iface: string, active: boolean }\>): void + +注销网卡热插拔事件，使用callback方式作为异步方法。 + +**系统接口**：此接口为系统接口。 + +**需要权限**：ohos.permission.GET_NETWORK_INFO + +**系统能力**：SystemCapability.Communication.NetManager.Ethernet + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | --------------------------------------- | ---- | ---------- | +| type | string | 是 | 订阅的事件类型，'interfaceStateChange'。 | +| callback | AsyncCallback\<{ iface: string, active: boolean }> | 否 | 回调函数。
iface：网卡名称。
active：是否处于激活状态（true：激活；false：未激活） | + +**错误码：** + +| 错误码ID | 错误信息 | +| ------- | -------------------------------------------- | +| 201 | Permission denied. | +| 202 | Applicable only to system applications. | +| 401 | Parameter error. | + +**示例：** + +```js +ethernet.off('interfaceStateChange'); +``` + ## InterfaceConfiguration 以太网连接配置网络信息。 diff --git a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md index 88ee05165f..c2060139ba 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-webSocket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-webSocket.md @@ -95,6 +95,9 @@ connect(url: string, callback: AsyncCallback\): void 根据URL地址，建立一个WebSocket连接，使用callback方式作为异步方法。 +> **说明：** +> 可通过监听error事件获得该接口的执行结果，错误发生时会得到错误码：200。 + **需要权限**：ohos.permission.INTERNET **系统能力**：SystemCapability.Communication.NetStack @@ -133,6 +136,9 @@ connect(url: string, options: WebSocketRequestOptions, callback: AsyncCallback\< 根据URL地址和header，建立一个WebSocket连接，使用callback方式作为异步方法。 +> **说明：** +> 可通过监听error事件获得该接口的执行结果，错误发生时会得到错误码：200。 + **需要权限**：ohos.permission.INTERNET **系统能力**：SystemCapability.Communication.NetStack @@ -177,6 +183,9 @@ connect(url: string, options?: WebSocketRequestOptions): Promise\ 根据URL地址和header，建立一个WebSocket连接，使用Promise方式作为异步方法。 +> **说明：** +> 可通过监听error事件获得该接口的执行结果，错误发生时会得到错误码：200。 + **需要权限**：ohos.permission.INTERNET **系统能力**：SystemCapability.Communication.NetStack @@ -587,7 +596,7 @@ on(type: 'error', callback: ErrorCallback): void | 参数名 | 类型 | 必填 | 说明 | | -------- | ------------- | ---- | ------------------------------- | | type | string | 是 | 'error'：WebSocket的Error事件。 | -| callback | ErrorCallback | 是 | 回调函数。 | +| callback | ErrorCallback | 是 | 回调函数。
常见错误码：200 | **示例：** -- GitLab