From c4721e9f59fd84c7f5c4c78afdfc4854b3c3365f Mon Sep 17 00:00:00 2001 From: xuyong Date: Wed, 26 Jan 2022 20:34:36 +0800 Subject: [PATCH] =?UTF-8?q?HiSysEvent=20TAG=E8=AE=A2=E9=98=85=20API?= =?UTF-8?q?=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- .../subsystems/subsys-dfx-hisysevent-read.md | 89 ++++++++++++------- 1 file changed, 59 insertions(+), 30 deletions(-) diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-read.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-read.md index 104aad22a5..98de173c2c 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-read.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-read.md @@ -15,27 +15,27 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接 **表 1** HiSysEvent订阅接口 -

接口名

+ - - - - - @@ -43,41 +43,70 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接 **表 2** ListenerRule订阅规则对象 - | 接口名称 | 返回值 | 描述 | - | -------- | ------ | ------ | - | ListenerRule(const std::string& tag, RuleType ruleType = RuleType::WHOLE_WORD) | 事件标签订阅规则对象 | 创建事件标签订阅规则对象 | - | ListenerRule(const std::string& domain, const std::string& eventName, RuleType ruleType = RuleType::WHOLE_WORD) | 事件领域与事件名称订阅规则对象 | 创建事件领域与事件名称订阅规则对象 | - | ListenerRule(const std::string& domain, const std::string& eventName, const std::string& tag, RuleType ruleType = RuleType::WHOLE_WORD) | 事件领域、事件名称，事件标签订阅规则对象 | 创建事件领域、事件名称，事件标签订阅规则对象 | - -- 参数tag：开发者自定义订阅规则的HisysEvent事件标签。事件标签字符串最大长度16个字符（含），有效字符包含大小写字母及数字。 - -- 参数domain：开发者自定义订阅规则的HisysEvent事件领域。事件领域字符串最大长度16个字符（含），有效字符包含大写字母、数字及下划线。 - -- 参数eventName：开发者自定义订阅规则的HisysEvent事件名称。事件名称字符串最大长度32个字符（含），有效字符包含大写字母、数字及下划线。 + +

接口名称

描述

+

描述

int HiSysEventManager::AddEventListener(std::shared_ptr<HiSysEventSubscribeCallBackBase> listener, std::vector<ListenerRule>& rules)

+

int HiSysEventManager::AddEventListener(std::shared_ptr<HiSysEventSubscribeCallBackBase> listener, std::vector<ListenerRule>& rules)

接口功能：注册订阅HiSysEvent系统事件侦听对象，可设置规则订阅某些事件。

+

接口功能：
  注册订阅HiSysEvent系统事件侦听对象，可设置规则订阅某些事件。

输入参数：

  • listener：订阅回调对象。
  • rules：事件订阅规则。

返回值：

  • 0：订阅成功，重复订阅。
  • 1：订阅成功，初次订阅。
  • 其他返回值：订阅失败。

void HiSysEventManager::RemoveListener(std::shared_ptr<HiSysEventSubscribeCallBackBase> listener)

+

void HiSysEventManager::RemoveListener(std::shared_ptr<HiSysEventSubscribeCallBackBase> listener)

接口功能：移除订阅hisysevent系统事件侦听对象。

+

接口功能：
  移除订阅hisysevent系统事件侦听对象。

输入参数：

  • listener：订阅回调对象。
-

返回值：无。

+

返回值：
无。
+ + + + + + + + + + + + + +

接口名称

+

描述

+

ListenerRule(const std::string& tag, RuleType ruleType = RuleType::WHOLE_WORD)

+

接口功能：
  订阅规则构造函数，创建事件标签订阅规则对象。

+

输入参数：

+
    +
  • tag：开发者自定义订阅规则的HisysEvent事件标签，字符串类型，最大长度16个字符（含），有效字符包含大小写字母及数字。
    • +
  • ruleType：开发者自定义订阅规则的规则类型，RuleType枚举类型(参考表3)。
+

ListenerRule(const std::string& domain, const std::string& eventName, RuleType ruleType = RuleType::WHOLE_WORD)

+

接口功能：
  订阅规则构造函数，创建事件领域与事件名称订阅规则对象。

+

输入参数：

+
    +
  • domain：开发者自定义订阅规则的HisysEvent事件领域，字符串类型，最大长度16个字符（含），有效字符包含大写字母、数字及下划线。
    • +
  • eventName：开发者自定义订阅规则的HisysEvent事件名称，字符串类型，最大长度32个字符（含），有效字符包含大写字母、数字及下划线。
    • +
  • ruleType：开发者自定义订阅规则的规则类型，RuleType枚举类型(参考表3)。
+

ListenerRule(const std::string& domain, const std::string& eventName, const std::string& tag, RuleType ruleType = RuleType::WHOLE_WORD)

+

接口功能：
  订阅规则构造函数，创建事件领域、事件名称，事件标签订阅规则对象。

+

输入参数：

+
    +
  • tag：开发者自定义订阅规则的HisysEvent事件标签，字符串类型，最大长度16个字符（含），有效字符包含大小写字母及数字。
    • +
  • domain：开发者自定义订阅规则的HisysEvent事件领域，字符串类型，最大长度16个字符（含），有效字符包含大写字母、数字及下划线。
    • +
  • eventName：开发者自定义订阅规则的HisysEvent事件名称，字符串类型，最大长度32个字符（含），有效字符包含大写字母、数字及下划线。
    • +
  • ruleType：开发者自定义订阅规则的规则类型，RuleType枚举类型(参考表3)。
+
-- 参数ruleType：开发者自定义订阅规则的规则类型。取值为枚举RuleType，具体值如下表。 +**表 3** RuleType类型 - | 类型 | 描述 | - | ---------- | ------------- | - | WHOLE_WORD | 全词匹配类型 | - | PREFIX | 前缀匹配类型 | - | REGULAR | 正则匹配类型 | +| 枚举值 | 描述 | +| ------------ | ------------- | +| WHOLE_WORD | 全词匹配类型 | +| PREFIX | 前缀匹配类型 | +| REGULAR | 正则匹配类型 | -**表 3** HiSysEventSubscribeCallBackBase订阅对象 +**表 4** HiSysEventSubscribeCallBackBase订阅对象 -

接口名称

+ + - - - -- GitLab

接口名称

描述

+

描述

void HiSysEventSubscribeCallBackBase::OnHandle(const std::string& domain, const std::string& eventName, const int eventType, const std::string& eventDetail)

+

void HiSysEventSubscribeCallBackBase::OnHandle(const std::string& domain, const std::string& eventName, const int eventType, const std::string& eventDetail)

接口功能：订阅事件的回调接口。

+

接口功能：
  订阅事件的回调接口。

输入参数：

  • domain：事件所属领域。
  • eventName：事件的名称。
  • eventType：事件类型。
  • eventDetail：包含事件相关信息的字符串，以json的形式体现。
-

返回值：无。

+

返回值：
  无。