From 7539dc88c049d6157f5fe1e9e7c13568eba51666 Mon Sep 17 00:00:00 2001 From: xujie Date: Tue, 22 Aug 2023 18:30:53 +0800 Subject: [PATCH] The description of the mdns interface was added Change-Id: I1496311de10b4e05b35973fcfe29f2baf0c4b220 Signed-off-by: xujie --- .../application-dev/connectivity/net-mdns.md | 19 +++ .../reference/apis/js-apis-net-mdns.md | 142 +++++++++++++++++- .../reference/apis/js-apis-socket.md | 4 +- 3 files changed, 162 insertions(+), 3 deletions(-) diff --git a/zh-cn/application-dev/connectivity/net-mdns.md b/zh-cn/application-dev/connectivity/net-mdns.md index 63e68ff2ff..e1171c3aa2 100644 --- a/zh-cn/application-dev/connectivity/net-mdns.md +++ b/zh-cn/application-dev/connectivity/net-mdns.md @@ -28,9 +28,13 @@ MDNS管理的典型场景有： | ohos.net.mdns.DiscoveryService | startSearchingMDNS(): void | 开始搜索局域网内的mDNS服务。 | | ohos.net.mdns.DiscoveryService | stopSearchingMDNS(): void | 停止搜索局域网内的mDNS服务。 | | ohos.net.mdns.DiscoveryService | on(type: 'discoveryStart', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void | 订阅开启监听mDNS服务的通知。 | +| ohos.net.mdns.DiscoveryService | off(type: 'discoveryStart', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void | 取消开启监听mDNS服务的通知。 | | ohos.net.mdns.DiscoveryService | on(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void | 订阅停止监听mDNS服务的通知。 | +| ohos.net.mdns.DiscoveryService | off(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void | 取消停止监听mDNS服务的通知。 | | ohos.net.mdns.DiscoveryService | on(type: 'serviceFound', callback: Callback\): void | 订阅发现mDNS服务的通知。 | +| ohos.net.mdns.DiscoveryService | off(type: 'serviceFound', callback: Callback\): void | 取消发现mDNS服务的通知。 | | ohos.net.mdns.DiscoveryService | on(type: 'serviceLost', callback: Callback\): void | 订阅移除mDNS服务的通知。 | +| ohos.net.mdns.DiscoveryService | off(type: 'serviceLost', callback: Callback\): void | 取消移除mDNS服务的通知。 | ## 管理本地服务 @@ -98,6 +102,7 @@ mdns.removeLocalService(context, localServiceInfo, function (error, data) { 4. 订阅mDNS服务发现相关状态变化。 5. 启动搜索局域网内的mDNS服务。 6. 停止搜索局域网内的mDNS服务。 +7. 取消订阅的mdns服务。 ```js // 从@ohos.net.mdns中导入mdns命名空间 @@ -139,4 +144,18 @@ discoveryService.startSearchingMDNS(); // 停止搜索局域网内的mDNS服务 discoveryService.stopSearchingMDNS(); + +// 取消订阅的mdns服务 +discoveryService.off('discoveryStart', (data) => { + console.log(JSON.stringify(data)); +}); +discoveryService.off('discoveryStop', (data) => { + console.log(JSON.stringify(data)); +}); +discoveryService.off('serviceFound', (data) => { + console.log(JSON.stringify(data)); +}); +discoveryService.off('serviceLost', (data) => { + console.log(JSON.stringify(data)); +}); ``` \ No newline at end of file diff --git a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md index fab925b78e..b259fb04fd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md +++ b/zh-cn/application-dev/reference/apis/js-apis-net-mdns.md @@ -718,6 +718,41 @@ discoveryService.on('discoveryStart', (data) => { discoveryService.stopSearchingMDNS(); ``` +### off('discoveryStart')10+ + +off(type: 'discoveryStart', callback?: Callback<{ serviceInfo: LocalServiceInfo, errorCode?: MdnsError }>): void; + +取消开启监听mDNS服务的通知。 + +**系统能力**：SystemCapability.Communication.NetManager.MDNS + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|-------------|--------------|-----------|-----------------------------------------------------| +| type | string | 是 |取消订阅的事件，固定为'discoveryStart'。
discoveryStart：开始搜索局域网内的mDNS服务事件。 | +| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MdnsError](#mdnserror)}> | 是 | mDNS服务的信息和事件错误信息。 | + +**示例：** + +```js +// 参考mdns.createDiscoveryService +let context = globalThis.context; +let serviceType = "_print._tcp"; +let discoveryService = mdns.createDiscoveryService(context, serviceType); +discoveryService.startSearchingMDNS(); + +discoveryService.on('discoveryStart', (data) => { + console.log(JSON.stringify(data)); +}); + +discoveryService.stopSearchingMDNS(); + +discoveryService.off('discoveryStart', (data) => { + console.log(JSON.stringify(data)); +}); +``` + ### on('discoveryStop')10+ on(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void @@ -749,6 +784,41 @@ discoveryService.on('discoveryStop', (data) => { discoveryService.stopSearchingMDNS(); ``` +### off('discoveryStop')10+ + +off(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MdnsError}>): void + +取消订阅停止监听mDNS服务的通知。 + +**系统能力**：SystemCapability.Communication.NetManager.MDNS + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|-------------|--------------|-----------|-----------------------------------------------------| +| type | string | 是 |取消订阅的事件'discoveryStop'。
discoveryStop：停止搜索局域网内的mDNS服务事件。 | +| callback | Callback<{serviceInfo: [LocalServiceInfo](#localserviceinfo), errorCode?: [MdnsError](#mdnserror)}> | 是 | mDNS服务的信息和事件错误信息。 | + +**示例：** + +```js +// 参考mdns.createDiscoveryService +let context = globalThis.context; +let serviceType = "_print._tcp"; +let discoveryService = mdns.createDiscoveryService(context, serviceType); +discoveryService.startSearchingMDNS(); + +discoveryService.on('discoveryStop', (data) => { + console.log(JSON.stringify(data)); +}); + +discoveryService.stopSearchingMDNS(); + +discoveryService.off('discoveryStop', (data) => { + console.log(JSON.stringify(data)); +}); +``` + ### on('serviceFound')10+ on(type: 'serviceFound', callback: Callback\): void @@ -780,6 +850,41 @@ discoveryService.on('serviceFound', (data) => { discoveryService.stopSearchingMDNS(); ``` +### off('serviceFound')10+ + +off(type: 'serviceFound', callback: Callback\): void + +取消订阅发现mDNS服务的通知。 + +**系统能力**：SystemCapability.Communication.NetManager.MDNS + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|-------------|--------------|-----------|-----------------------------------------------------| +| type | string | 是 |取消订阅的事件，固定为'serviceFound'。
serviceFound：发现mDNS服务事件。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 | + +**示例：** + +```js +// 参考mdns.createDiscoveryService +let context = globalThis.context; +let serviceType = "_print._tcp"; +let discoveryService = mdns.createDiscoveryService(context, serviceType); +discoveryService.startSearchingMDNS(); + +discoveryService.on('serviceFound', (data) => { + console.log(JSON.stringify(data)); +}); + +discoveryService.stopSearchingMDNS(); + +discoveryService.off('serviceFound', (data) => { + console.log(JSON.stringify(data)); +}); +``` + ### on('serviceLost')10+ on(type: 'serviceLost', callback: Callback\): void @@ -811,6 +916,41 @@ discoveryService.on('serviceLost', (data) => { discoveryService.stopSearchingMDNS(); ``` +### off('serviceLost')10+ + +off(type: 'serviceLost', callback: Callback\): void + +取消订阅移除mDNS服务的通知。 + +**系统能力**：SystemCapability.Communication.NetManager.MDNS + +**参数：** + +| 参数名 | 类型 | 必填 | 说明 | +|-------------|--------------|-----------|-----------------------------------------------------| +| type | string | 是 |取消订阅的事件，固定为'serviceLost'。
serviceLost：移除mDNS服务事件。 | +| callback | Callback<[LocalServiceInfo](#localserviceinfo)> | 是 | mDNS服务的信息。 | + +**示例：** + +```js +// 参考mdns.createDiscoveryService +let context = globalThis.context; +let serviceType = "_print._tcp"; +let discoveryService = mdns.createDiscoveryService(context, serviceType); +discoveryService.startSearchingMDNS(); + +discoveryService.on('serviceLost', (data) => { + console.log(JSON.stringify(data)); +}); + +discoveryService.stopSearchingMDNS(); + +discoveryService.off('serviceLost', (data) => { + console.log(JSON.stringify(data)); +}); +``` + ## LocalServiceInfo10+ mDNS服务信息 @@ -846,4 +986,4 @@ mDNS错误信息。 | --------------- | ---- | ----------- | | INTERNAL_ERROR | 0 | 内部错误导致操作失败。（暂不支持） | | ALREADY_ACTIVE | 1 | 服务已经存在导致操作失败。（暂不支持） | -| MAX_LIMIT | 2 | 请求超过最大限制导致操作失败。（暂不支持） | \ No newline at end of file +| MAX_LIMIT | 2 | 请求超过最大限制导致操作失败。（暂不支持） | diff --git a/zh-cn/application-dev/reference/apis/js-apis-socket.md b/zh-cn/application-dev/reference/apis/js-apis-socket.md index bca9cb71fb..fc79882a4e 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-socket.md +++ b/zh-cn/application-dev/reference/apis/js-apis-socket.md @@ -2515,7 +2515,7 @@ tcpServer.on('connect', function(client) { ### off('close')10+ -on(type: 'close', callback: Callback\): void +off(type: 'close', callback?: Callback): void 取消订阅TCPSocketConnection的关闭事件。使用callback方式作为异步方法。 @@ -5706,7 +5706,7 @@ tlsServer.on('connect', function(client) { ### off('close')10+ -on(type: 'close', callback: Callback\): void +off(type: 'close', callback?: Callback): void 取消订阅TLSSocketConnection的关闭事件。使用callback方式作为异步方法。 -- GitLab