Skip to content

D
Docs

OpenHarmony / Docs
大约 1 年 前同步成功

通知 159
Star 292
Fork 28
D
Docs
提交 3bce72c3 编写于 作者: X xuyong
浏览文件
操作

HiSysEvent Read API更新 

Signed-off-by: Nxuyong <xuyong59@huawei.com>
上级 b2f9cb78
隐藏空白更改
内联 并排
Showing with 58 addition and 38 deletion
zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-read.md
浏览文件 @ 3bce72c3
......@@ -21,7 +21,7 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接
</th>
</tr>
</thead>
<tbody><tr id="row16441155818499"><td class="cellrowborder" valign="top" width="48.120000000000005%" headers="mcps1.2.3.1.1 "><p id="p877916438211"><a name="p877916438211"></a><a name="p877916438211"></a>int HiSysEventManager::AddEventListener(std::shared_ptr&lt;HiSysEventSubscribeCallBackBase&gt; listener, std::vector&lt;struct ListenerRule&gt;&amp; rules)</p>
<tbody><tr id="row16441155818499"><td class="cellrowborder" valign="top" width="48.120000000000005%" headers="mcps1.2.3.1.1 "><p id="p877916438211"><a name="p877916438211"></a><a name="p877916438211"></a>int HiSysEventManager::AddEventListener(std::shared_ptr&lt;HiSysEventSubscribeCallBackBase&gt; listener, std::vector&lt;ListenerRule&gt;&amp; rules)</p>
</td>
<td class="cellrowborder" valign="top" width="51.88%" headers="mcps1.2.3.1.2 "><p id="p14727325133216"><a name="p14727325133216"></a><a name="p14727325133216"></a>接口功能：注册订阅HiSysEvent系统事件侦听对象，可设置规则订阅某些事件。</p>
<p id="p167271525203213"><a name="p167271525203213"></a><a name="p167271525203213"></a>输入参数：</p>
......@@ -43,31 +43,26 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接
**表 2** ListenerRule订阅规则对象
<a name="table1144011610564"></a>
<table><thead align="left"><tr id="row124411716175611"><th class="cellrowborder" valign="top" width="48.11%" id="mcps1.2.3.1.1"><p id="p19441151675610"><a name="p19441151675610"></a><a name="p19441151675610"></a>属性名称</p>
</th>
<th class="cellrowborder" valign="top" width="51.89%" id="mcps1.2.3.1.2"><p id="p16441171616563"><a name="p16441171616563"></a><a name="p16441171616563"></a>描述</p>
</th>
</tr>
</thead>
<tbody><tr id="row174411216105615"><td class="cellrowborder" valign="top" width="48.11%" headers="mcps1.2.3.1.1 "><p id="p496413536613"><a name="p496413536613"></a><a name="p496413536613"></a><span>uint32_t</span> ruleType</p>
</td>
<td class="cellrowborder" valign="top" width="51.89%" headers="mcps1.2.3.1.2 "><p id="p94416160565"><a name="p94416160565"></a><a name="p94416160565"></a>规则类型（匹配范围包括domain以及eventName）：</p>
<a name="ul1652866141814"></a><a name="ul1652866141814"></a><ul id="ul1652866141814"><li>1：全字符匹配。</li><li>2：前缀匹配。</li><li>3：正则表达式匹配。</li><li>其他值：无效的匹配方式。</li></ul>
</td>
</tr>
<tr id="row64411816125614"><td class="cellrowborder" valign="top" width="48.11%" headers="mcps1.2.3.1.1 "><p id="p1258135313712"><a name="p1258135313712"></a><a name="p1258135313712"></a>std::string domain</p>
</td>
<td class="cellrowborder" valign="top" width="51.89%" headers="mcps1.2.3.1.2 "><a name="ul14905926102311"></a><a name="ul14905926102311"></a><ul id="ul14905926102311"><li>domain：事件所属领域，如果传入的是空字符串，则默认事件领域字段匹配成功。</li></ul>
</td>
</tr>
<tr id="row244161615619"><td class="cellrowborder" valign="top" width="48.11%" headers="mcps1.2.3.1.1 "><p id="p227913101887"><a name="p227913101887"></a><a name="p227913101887"></a>std::string eventName</p>
</td>
<td class="cellrowborder" valign="top" width="51.89%" headers="mcps1.2.3.1.2 "><a name="ul248063132319"></a><a name="ul248063132319"></a><ul id="ul248063132319"><li>eventName：事件的名称，如果传入的是空字符串，则默认事件名称字段匹配成功。</li></ul>
</td>
</tr>
</tbody>
</table>
| 接口名称 | 返回值 | 描述 |
| --------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | -------------------------------------------- |
| 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个字符（含），有效字符包含大写字母、数字及下划线。
- 参数ruleType：开发者自定义订阅规则的规则类型。取值为枚举RuleType，具体值如下表。
| 类型 | 描述 |
| ---------- | ------------- |
| INVALID | 无效匹配类型 |
| WHOLE_WORD | 全词匹配类型 |
| PREFIX | 前缀匹配类型 |
| REGULAR | 正则匹配类型 |
**表 3** HiSysEventSubscribeCallBackBase订阅对象
......@@ -107,11 +102,11 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接
- 注册回调对象：
HiSysEventManager::AddEventListener\(std::shared\_ptr<HiSysEventSubscribeCallBackBase\> listener, std::vector<struct ListenerRule\>& rules\)。
HiSysEventManager::AddEventListener\(std::shared\_ptr<HiSysEventSubscribeCallBackBase\> listener, std::vector<ListenerRule\>& rules\)。
```
// 以下是订阅domain=HIVIEWDFX的所有系统事件的应用例子
// 以下是订阅系统事件的示例
#include "hisysevent_manager.h"
#include <iostream>
namespace OHOS {
......@@ -133,11 +128,13 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接
// 调用订阅接口注册开发实现的订阅对象
auto toolListener = std::make_shared<HiSysEventToolListener>();
struct ListenerRule rule;
rule.ruleType = 1; // 1: default type
rule.domain = "HIVIEWDFX";
std::vector<struct ListenerRule> sysRules;
sysRules.push_back(rule);
ListenerRule tagRule("dfx"); // 事件标签规则订阅，规则类型默认的全词匹配类型
ListenerRule regRule("dfx.*", RuleType::REGULAR); // 事件标签规则订阅，规则类型为正则匹配类型
ListenerRule domainNameRule("HIVIEWDFX", "APP_USAGE", RuleType::PREFIX); // 事件领域及事件名称规则订阅，规则类型前缀匹配类型
std::vector<ListenerRule> sysRules;
sysRules.push_back(tagRule);
sysRules.push_back(regRule);
sysRules.push_back(domainNameRule);
HiSysEventManager::AddEventListener(toolListener, sysRules);
```
......
zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md
浏览文件 @ 3bce72c3
......@@ -14,19 +14,42 @@
工具预置在/system/bin目录下，命令可以在任意目录执行。
```
hisysevent [-r | -l [-s <time> -e <time> -m <count>]]
-r get real hisysevent log.
hisysevent [-r [-d | -c [WHOLE_WORD|PREFIX|REGULAR] -t <tag> | -c [WHOLE_WORD|PREFIX|REGULAR] -o <domain> -n <eventName> ]
| -l [-s <time> -e <time> -m <count>]]
-r subscribe on empty domain, eventname and tag
-r -c [WHOLE_WORD|PREFIX|REGULAR] -t <tag>, subscribe on tag
-r -c [WHOLE_WORD|PREFIX|REGULAR] -o <domain> -n <eventName>, subscribe on domain and event name
-r -d set debug mode, both options must appear at the same time.
-l -s <begin time> -e <end time> -m <max hisysevent count>
get history hisysevent log, begin time should not be earlier than end time.
get history hisysevent log, begin time should not be earlier than end time.
```
2. 查询实时HiSysEvent事件的命令：
2. 订阅实时HiSysEvent事件的命令：
```
hisysevent -r
```
当实时HiSysEvent事件过来的时候，会在控制台上打印一条HiSysEvent事件。
当有实时HiSysEvent事件发生，会在控制台上打印该HiSysEvent事件。
```
hisysevent -r -c [WHOLE_WORD|PREFIX|REGULAR] -t <tag>
```
通过事件标签规则订阅实时HiSysEvent事件，当有与指定的事件标签以指定的匹配类型匹配的实时HiSysEvent事件发生，会在控制台上打印该HiSysEvent事件。
-c用来指定匹配规则，包括“全词匹配”、“前缀匹配”以及“正则匹配”三种模式，如果没有-c，则默认使用全词匹配模式。
-t用来指定字符串和HiSysEvent事件的标签进行匹配，如果没有-t，则使用空字符串。
```
hisysevent -r -c [WHOLE_WORD|PREFIX|REGULAR] -o <domain> -n <eventName>
```
通过事件领域及事件名称规则订阅实时HiSysEvent事件，当有与指定的的事件领域及事件名称以指定的匹配类型匹配的实时HiSysEvent事件发生，会在控制台上打印该HiSysEvent事件。
-c 用来指定匹配规则，包括“全词匹配”、“前缀匹配”以及“正则匹配”三种模式，如果没有-c，则默认使用全词匹配类型。
-o 用来指定事件领域，如果没有-o，则使用空字符串。
-n 用来指定事件名称，如果没有-n，则使用空字符串。
当同时通过-t、-o及-n指定了相关订阅规则参数设置，则判断设置的事件标签是否为空，若不为空，则使用事件标签规则进行订阅，否则使用事件领域及事件名称订阅规则进行订阅。
3. 查询历史HiSysEvent事件的命令：
......
Markdown is supported
0% 或 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑！
想要评论请 注册 或