!16543 优化Hicollie开发指导文档

Merge pull request !16543 from honghecun/cherry-pick-1679899576

zh-cn/device-dev/subsystems/subsys-dfx-hicollie.md

@@ -8,45 +8,28 @@ HiCollie提供了软件看门狗功能。针对系统服务死锁、应用主线
 
 ## 接口说明
 
-  **表1** C++接口功能描述表
+  **表1** XCollieChecker接口
 
-| 所属类 | 接口定义 | 描述 | 
-| -------- | -------- | -------- |
-| XCollieChecker类接口 | virtual&nbsp;void&nbsp;CheckBlock() | 接口功能：卡死检测回调函数。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 | 
-| XCollieChecker类接口 | virtual&nbsp;void&nbsp;CheckThreadBlock() | 接口功能：线程卡死检测回调函数。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 | 
-| XCollie类接口 | void&nbsp;RegisterXCollieChecker(const&nbsp;sptr&amp;lt;XCollieChecker&amp;gt;&nbsp;&amp;checker,&nbsp;unsigned&nbsp;int&nbsp;type) | 接口功能：线程卡死检测回调函数注册。<br/>输入参数：<br/>-&nbsp;checker：XCollieChecker实例指针。<br/>-&nbsp;type：卡死检测类型，取值设置为XCOLLIE_THREAD。<br/>输出参数：无。<br/>返回值：无。 | 
-| XCollie类接口 | int&nbsp;SetTimer(const&nbsp;std::string&nbsp;&amp;name,&nbsp;unsigned&nbsp;int&nbsp;timeout,&nbsp;std::function&amp;lt;void&nbsp;(void&nbsp;_)&amp;gt;&nbsp;func,&nbsp;void&nbsp;_arg,&nbsp;unsigned&nbsp;int&nbsp;flag) | 接口功能：添加定时器。<br/>输入参数：<br/>-&nbsp;name：定时器名称。<br/>-&nbsp;timeout：超时时间，单位为秒。<br/>-&nbsp;func：超时回调函数。<br/>-&nbsp;arg：超时回调函数参数指针。<br/>-&nbsp;flag：定时器操作类型。<br/>&nbsp;&nbsp;XCOLLIE_FLAG_DEFAULT&nbsp;&nbsp;//&nbsp;其他三个选项功能之和<br/>&nbsp;&nbsp;XCOLLIE_FLAG_NOOP&nbsp;//&nbsp;仅调用超时回调函数<br/>&nbsp;&nbsp;XCOLLIE_FLAG_LOG&nbsp;//&nbsp;&nbsp;生成超时故障日志<br/>&nbsp;&nbsp;XCOLLIE_FLAG_RECOVERY&nbsp;//&nbsp;&nbsp;进程退出<br/>输出参数：无。<br/>返回值：成功返回定时器标识，失败返回-1。 | 
-| XCollie类接口 | bool&nbsp;UpdateTimer(int&nbsp;id,&nbsp;unsigned&nbsp;int&nbsp;timeout) | 接口功能：更新定时器。<br/>输入参数：<br/>-&nbsp;id：定时器标识。<br/>-&nbsp;timeout：超时时间，单位为秒。<br/>输出参数：无。<br/>返回值：成功返回true，失败返回false。 | 
-| XCollie类接口 | void&nbsp;CancelTimer(int&nbsp;id) | 接口功能：取消定时器。<br/>输入参数：定时器标识。<br/>输出参数：无。<br/>返回值：无。 | 
+| 接口名称 | 描述 |
+| -------- | -------- |
+| virtual void CheckBlock() | 接口功能：卡死检测回调函数。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 |
+| virtual void CheckThreadBlock() | 接口功能：线程卡死检测回调函数。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 |
 
 
-## 效果
+  **表2** XCollie接口
 
-日志打印：
-
-  
-```
-timeout: TimeoutTimer start at 1611040305 to check 1s ago
-
-----------StacktraceCatcher CurrentTime:2021-01-19 15:11:45 Unexecuted(-1)(LogType:Stacktrace Pid:27689 Process:XCollieTimeoutModuleTest)----------
-
-
------ pid 27689 at 2021-01-19 15:11:45 -----
-Cmd line: ./XCollieTimeoutModuleTest
-ABI: 'arm64'
-
-"XCollieTimeoutM" sysTid=27689
-    #01 pc 00000000000174cc  /data/test/XCollieTimeoutModuleTest
-```
+| 接口名称 | 描述 |
+| -------- | -------- |
+| void RegisterXCollieChecker(const sptr&lt;XCollieChecker&gt; &amp;checker, unsigned int type) | 接口功能：线程卡死检测回调函数注册。<br/>输入参数：<br/>- **checker**：XCollieChecker实例指针。<br/>- **type**：卡死检测类型，取值设置为**XCOLLIE_THREAD**。<br/>输出参数：无。<br/>返回值：无。 |
+| int SetTimer(const std::string &amp;name, unsigned int timeout, std::function&lt;void(void*)&gt; func, void *arg, unsigned int flag) | 接口功能：添加定时器。<br/>输入参数：<br/>- **name**：定时器名称。<br/>- **timeout**：超时时间，单位为秒。<br/>- **func**：超时回调函数。<br/>- **arg**：超时回调函数参数指针。<br/>- **flag**：定时器操作类型。<br/>  XCOLLIE_FLAG_DEFAULT：其他三个选项功能之和<br/>  XCOLLIE_FLAG_NOOP：仅调用超时回调函数<br/>  XCOLLIE_FLAG_LOG：生成超时故障日志<br/>  XCOLLIE_FLAG_RECOVERY：进程退出<br/>输出参数：无。<br/>返回值：成功返回定时器标识，失败返回 **-1**。 |
+| bool UpdateTimer(int id, unsigned int timeout) | 接口功能：更新定时器。<br/>输入参数：<br/>- **id**：定时器标识。<br/>- **timeout**：超时时间，单位为秒。<br/>输出参数：无。<br/>返回值：成功返回**true**，失败返回**false**。 |
+| void CancelTimer(int id) | 接口功能：取消定时器。<br/>输入参数：<br/>- **id**：定时器标识。<br/>输出参数：无。<br/>返回值：无。 |
 
 
 ## 开发实例
 
 
-### C++接口开发实例
-
-
-### 线程卡死监控
+### 线程卡死监控开发实例
 
 线程卡死监控功能需要开发者实现两个卡死检测回调函数，XCollieChecker类的CheckBlock和CheckThreadBlock接口函数。实现了该回调函数之后，开发者还需要通过XCollie类的RegisterXCollieChecker函数，将该回调函数的类实例成功注册。卡死监控线程会定时执行全部已成功注册的回调函数，检查线程逻辑完成标志位，判定已经成功注册的线程逻辑是否被卡死。
 
@@ -59,7 +42,7 @@ ABI: 'arm64'
 
    在业务代码中使用：
 
-     
+   
    ```
    void MyXCollieChecker::CheckLock()
    {
@@ -78,13 +61,13 @@ ABI: 'arm64'
    ```
 
 2. 编译设置，在BUILD.gn里增加子系统SDK依赖：
-     
+   
    ```
    external_deps = [ "hiviewdfx:libxcollie" ]
    ```
 
 
-### 超时监控
+### 超时监控开发实例
 
 单个进程通过SetTimer接口函数添加定时器最多可以设置128个，超过上限则添加定时器操作会失败。
 
@@ -96,7 +79,7 @@ ABI: 'arm64'
    ```
 
      在业务代码中使用（添加/更新/取消）：
-     
+   
    ```
    std::function<void(void *)> callback = [](void *args)
    {
@@ -112,7 +95,7 @@ ABI: 'arm64'
    ```
 
 2. 编译设置，在BUILD.gn里增加子系统SDK依赖：
-     
+   
    ```
    external_deps = [ "hiviewdfx:libxcollie" ]
    ```