Skip to content

D
Docs

OpenHarmony / Docs
1 年多 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 ca6c8711 编写于 作者: L liyufan
浏览文件
操作

fix comments 

Signed-off-by: Nliyufan <liyufan5@huawei.com>
上级 1393b034
显示空白变更内容
内联 并排
Showing with 158 addition and 28 deletion
zh-cn/application-dev/reference/apis/js-apis-net-mdns.md
浏览文件 @ ca6c8711
......@@ -12,8 +12,7 @@ import mdns from '@ohos.net.mdns'
```
## mdns.addLocalService
function addLocalService(context: Context, serviceInfo: LocalServiceInfo,
callback: AsyncCallback\<LocalServiceInfo>): void;
addLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void
添加一个mDNS服务，使用callback方式作为异步方法。
......@@ -23,7 +22,7 @@ function addLocalService(context: Context, serviceInfo: LocalServiceInfo,
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功添加error为undefined，data为添加到本地的mdns服务信息。 |
......@@ -38,6 +37,9 @@ function addLocalService(context: Context, serviceInfo: LocalServiceInfo,
| 2204008 | Service instance duplicated. |
| 2204010 | Send packet failed. |
>**错误码说明：**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例：**
```js
......@@ -62,7 +64,7 @@ mdns.addLocalService(context, localServiceInfo, function (error, data) {
## mdns.addLocalService
function addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>;
addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>
添加一个mDNS服务，使用Promise方式作为异步方法。
......@@ -72,7 +74,7 @@ function addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promi
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
**返回值：**
......@@ -92,6 +94,9 @@ function addLocalService(context: Context, serviceInfo: LocalServiceInfo): Promi
| 2204008 | Service instance duplicated. |
| 2204010 | Send packet failed. |
>**错误码说明：**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例：**
```js
......@@ -115,8 +120,7 @@ mdns.addLocalService(context, localServiceInfo).then(function (data) {
## mdns.removeLocalService
function removeLocalService(context: Context, serviceInfo: LocalServiceInfo,
callback: AsyncCallback\<LocalServiceInfo>): void;
removeLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void
移除一个mDNS服务，使用callback方式作为异步方法。
......@@ -126,7 +130,7 @@ function removeLocalService(context: Context, serviceInfo: LocalServiceInfo,
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功移除error为undefined，data为移除本地的mdns服务信息。 |
......@@ -141,6 +145,9 @@ function removeLocalService(context: Context, serviceInfo: LocalServiceInfo,
| 2204008 | Service instance duplicated. |
| 2204010 | Send packet failed. |
>**错误码说明：**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例：**
```js
......@@ -165,7 +172,7 @@ mdns.removeLocalService(context, localServiceInfo, function (error, data) {
## mdns.removeLocalService
function removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>;
removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>
移除一个mDNS服务. 使用Promise方式作为异步方法。
......@@ -175,7 +182,7 @@ function removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Pr
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
**返回值：**
......@@ -195,6 +202,9 @@ function removeLocalService(context: Context, serviceInfo: LocalServiceInfo): Pr
| 2204008 | Service instance duplicated. |
| 2204010 | Send packet failed. |
>**错误码说明：**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例：**
```js
......@@ -218,7 +228,7 @@ mdns.removeLocalService(context, localServiceInfo).then(function (data) {
## mdns.createDiscoveryService
function createDiscoveryService(context: Context, serviceType: string): DiscoveryService;
createDiscoveryService(context: Context, serviceType: string): DiscoveryService
返回一个DiscoveryService对象，该对象用于发现指定服务类型的mDNS服务。
......@@ -228,8 +238,8 @@ function createDiscoveryService(context: Context, serviceType: string): Discover
| 参数名 | 类型 | 必填 | 说明 |
|-------------|---------|-----------| ------------------------------------------------------------ |
| context | Context | 是 | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceType | string | Yes | 需要发现的mDNS服务类型。|
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceType | string | 是 | 需要发现的mDNS服务类型。|
**返回值：**
......@@ -240,15 +250,14 @@ function createDiscoveryService(context: Context, serviceType: string): Discover
**Example**
```js
serviceType = "_print._tcp"
let serviceType = "_print._tcp";
let discoveryService = mdns.createDiscoveryService(context, serviceType);
```
## mdns.resolveLocalService
function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo,
callback: AsyncCallback\<LocalServiceInfo>): void;
resolveLocalService(context: Context, serviceInfo: LocalServiceInfo, callback: AsyncCallback\<LocalServiceInfo>): void
解析一个mDNS服务，使用callback方式作为异步方法。
......@@ -258,7 +267,7 @@ function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo,
| 参数名 | 类型 | 必填 | 说明 |
|-------------|----------------------------------|-----------|-------------------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
| callback | AsyncCallback\<[LocalServiceInfo](#localserviceinfo)> | 是 | 回调函数。成功移除error为undefined，data为解析的mdns服务信息。 |
......@@ -273,6 +282,9 @@ function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo,
| 2204006 | Request timeout. |
| 2204010 | Send packet failed. |
>**错误码说明：**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例：**
```js
......@@ -297,7 +309,7 @@ mdns.resolveLocalService(context, localServiceInfo, function (error, data) {
## mdns.resolveLocalService
function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>;
resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): Promise\<LocalServiceInfo>
解析一个mDNS服务，使用Promise方式作为异步方法。
......@@ -307,7 +319,7 @@ function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): P
| 参数名 | 类型 | 必填 | 说明 |
|-------------|--------------|-----------|-----------------------------------------------------|
| context | Context | 是 | 应用的上下文。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| context | Context | 是 | 应用的上下文。<br>FA模型的应用Context定义见[Context](js-apis-inner-app-context.md)。<br>Stage模型的应用Context定义见[Context](js-apis-inner-application-uiAbilityContext.md)。 |
| serviceInfo | [LocalServiceInfo](#localserviceinfo) | 是 | mDNS服务的信息。 |
**返回值：**
......@@ -327,6 +339,9 @@ function resolveLocalService(context: Context, serviceInfo: LocalServiceInfo): P
| 2204006 | Request timeout. |
| 2204010 | Send packet failed. |
>**错误码说明：**
> 以上错误码的详细介绍参见[MDNS错误码](../errorcodes/errorcode-net-mdns.md)。
**示例：**
```js
......@@ -384,8 +399,7 @@ discoveryService.stopSearchingMDNS();
### on('discoveryStart')
on(type: 'discoveryStart',
callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MDNS_ERR}>): void;
on(type: 'discoveryStart', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MDNS_ERR}>): void
订阅开启监听mDNS服务的通知。
......@@ -414,8 +428,7 @@ discoveryService.stopSearchingMDNS();
### on('discoveryStop')
on(type: 'discoveryStop',
callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MDNS_ERR}>): void;
on(type: 'discoveryStop', callback: Callback<{serviceInfo: LocalServiceInfo, errorCode?: MDNS_ERR}>): void
订阅停止监听mDNS服务的通知。
......@@ -444,7 +457,7 @@ discoveryService.stopSearchingMDNS();
### on('serviceFound')
on(type: 'serviceFound', callback: Callback<[LocalServiceInfo](#localserviceinfo)>): void;
on(type: 'serviceFound', callback: Callback<[LocalServiceInfo](#localserviceinfo)>): void
订阅发现mDNS服务的通知。
......@@ -473,7 +486,7 @@ discoveryService.stopSearchingMDNS();
### on('serviceLost')
on(type: 'serviceLost', callback: Callback<[LocalServiceInfo](#localserviceinfo)>): void;
on(type: 'serviceLost', callback: Callback<[LocalServiceInfo](#localserviceinfo)>): void
订阅移除mDNS服务的通知。
......@@ -511,8 +524,8 @@ mDNS服务信息
| serviceType | string | 是 | mDNS服务的类型。格式_\<name>.<_tcp/_udp>，name长度小于63字符并且不能包含字符'.'。 |
| serviceName | string | 是 | mDNS服务的名字。 |
| port | number | 否 | mDNS服务的端口号。 |
| host | [NetAddress](js-apis-net-connection.md) | 否 | mDNS服务设备的IP地址。采用设备的IP，添加服务和移除服务时候不生效。 |
| serviceAttribute | serviceAttribute\<[ServiceAttribute](#serviceattribute)> | 是 | mDNS服务属性信息。 |
| host | [NetAddress](js-apis-net-connection.md#netaddress) | 否 | mDNS服务设备的IP地址。采用设备的IP，添加服务和移除服务时候不生效。 |
| serviceAttribute | serviceAttribute\<[ServiceAttribute](#serviceattribute)> | 否 | mDNS服务属性信息。 |
## ServiceAttribute
......@@ -523,7 +536,7 @@ mDNS服务属性信息
| 名称 | 类型 | 必填 | 说明 |
| --------------------- | ---------------------------------- | --- | ------------------------ |
| key | string | 是 | mDNS服务属性键值，键值长度应该小于9个字符。 |
| value | Array<number> | 是 | mDNS服务属性值。 |
| value | Array\<number> | 是 | mDNS服务属性值。 |
## MDNS_ERR
......
zh-cn/application-dev/reference/errorcodes/errorcode-net-mdns.md 0 → 100644
浏览文件 @ ca6c8711
# MDNS错误码
> **说明：**
>
> 以下仅介绍本模块特有错误码，通用错误码请参考[通用错误码说明文档](errorcode-universal.md)。
## 2100002 连接服务失败
**错误信息**
Operation failed. Cannot connect to service.
**错误描述**
操作失败，连接系统服务发生异常。
**可能原因**
服务发生异常。
**处理步骤**
检查系统服务运行状态是否正常。
## 2100003 系统内部错误
**错误信息**
System internal error.
**错误描述**
系统内部错误。
**可能原因**
1.内存异常。
2.空指针。
**处理步骤**
1.检查内存空间是否充足，清理内存后重试。
2.系统异常，请稍后重试或重启设备。
## 2204003 重复注册
**错误信息**
Callback duplicated.
**错误描述**
callback 已经存在。
**可能原因**
重复注册相同名称和类型的mDNS服务。
**处理步骤**
检查mDNS服务是否存在。
## 2204008 删除服务失败
**错误信息**
Service instance duplicated.
**错误描述**
想要移除的服务不存在。
**可能原因**
之前已经把服务删除，二次删除相同服务。
**处理步骤**
检查mDNS服务是否存在。
## 2204010 发送消息失败
**错误信息**
Send packet failed.
**错误描述**
发送信息失败。
**可能原因**
局域网内不存在该mDNS服务。
**处理步骤**
检查局域网内目标mDNS服务是否存在。
## 2204006 解析服务超时
**错误信息**
Request timeout.
**错误描述**
解析服务超时。
**可能原因**
局域网内不存在该类型的mDNS服务。
**处理步骤**
检查局域网内目标类型的mDNS服务是否存在。
\ No newline at end of file
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或