harmony 鸿蒙hicollie.h
hicollie.h
概述
HiCollie模块对外提供检测业务线程卡死、卡顿，以及上报卡死事件的能力。
库： libohhicollie.so
系统能力： SystemCapability.HiviewDFX.HiCollie
起始版本： 12
相关模块：HiCollie
汇总
结构体
| 名称 | 描述 |
|---|---|
| struct HiCollie_DetectionParam | 检测业务线程卡顿的相关参数。请注意，API 12及以上支持。 |
| struct HiCollie_SetTimerParam | 定义OH_HiCollie_SetTimer函数的输入参数。 |
类型定义
| 名称 | 描述 |
|---|---|
| typedef enum HiCollie_ErrorCode HiCollie_ErrorCode | 错误码定义。 |
| typedef void(* OH_HiCollie_Task) (void) | 在业务线程卡死检测中，通过实现该函数来检测业务线程是否卡住。 HiCollie将在独立线程中每3秒调用一次该函数。 例如：该函数可实现向业务线程发送消息，在业务线程接收到消息之后，设置一个标记，检查这个标记，确定业务线程是否卡住。 |
| typedef void(* OH_HiCollie_BeginFunc) (const char *eventName) | 卡顿检测中,函数用于记录业务线程处理事件的开始时间。 检查处理事件的执行时间，HiCollie将检查每个事件的持续时间。如果超过预设阈值，上报jank事件。 该函数是在每个事件处理之前插入的回调函数。 |
| typedef void(* OH_HiCollie_EndFunc) (const char *eventName) | 卡顿检测中, 该函数用于检测业务线程处理事件是否卡顿。 检查处理事件的执行时间，HiCollie将检查每个事件的持续时间。如果超过预设阈值，上报jank事件。 该函数是在每个事件处理之后插入的回调函数。 |
| typedef struct HiCollie_DetectionParam HiCollie_DetectionParam | 检测业务线程卡顿的相关参数。请注意，API 12及以上支持。 |
| typedef void(* OH_HiCollie_Callback) (void *) | 当用户调用OH_HiCollie_SetTimer后，未在其自定义的任务超时时间阈值内调用OH_HiCollie_CancelTimer，回调函数将被执行。 |
| typedef enum HiCollie_Flag HiCollie_Flag | 定义函数执行超时时发生的动作。 |
| typedef struct HiCollie_SetTimerParam HiCollie_SetTimerParam | 定义OH_HiCollie_SetTimer函数的输入参数。 |
枚举
| 名称 | 描述 |
|---|---|
| HiCollie_ErrorCode { HICOLLIE_SUCCESS = 0, HICOLLIE_INVALID_ARGUMENT = 401, HICOLLIE_WRONG_THREAD_CONTEXT = 29800001, HICOLLIE_REMOTE_FAILED = 29800002, HICOLLIE_INVALID_TIMER_NAME = 29800003, HICOLLIE_INVALID_TIMEOUT_VALUE = 29800004, HICOLLIE_WRONG_PROCESS_CONTEXT = 29800005, HICOLLIE_WRONG_TIMER_ID_OUTPUT_PARAM = 29800006 } |
错误码定义。 |
| HiCollie_Flag { HICOLLIE_FLAG_DEFAULT = (~0), HICOLLIE_FLAG_NOOP = (0), HICOLLIE_FLAG_LOG = (1 << 0), HICOLLIE_FLAG_RECOVERY = (1 << 1) } |
定义函数执行超时时发生的动作。 |
函数
| 名称 | 描述 |
|---|---|
| HiCollie_ErrorCode OH_HiCollie_Init_StuckDetection (OH_HiCollie_Task task) | 注册应用业务线程卡死的周期性检测任务。用户实现回调函数, 用于定时检测业务线程卡死情况。 默认检测时间：3s上报BUSSINESS_THREAD_BLOCK_3S告警事件，6s上报BUSSINESS_THREAD_BLOCK_6S卡死事件。 |
| HiCollie_ErrorCode OH_HiCollie_Init_StuckDetectionWithTimeout (OH_HiCollie_Task task, uint32_t stuckTimeout) | 注册应用业务线程卡死的周期性检测任务。用户实现回调函数, 用于定时检测业务线程卡死情况。 开发者可以设置卡死检测时间，可设置的时间范围：[3, 15]，单位：秒。 |
| HiCollie_ErrorCode OH_HiCollie_Init_JankDetection (OH_HiCollie_BeginFunc *beginFunc, OH_HiCollie_EndFunc *endFunc, HiCollie_DetectionParam param) | 注册应用业务线程卡顿检测的回调函数。 线程卡顿监控功能需要开发者实现两个卡顿检测回调函数, 分别放在业务线程处理事件的前后。作为插桩函数，监控业务线程处理事件执行情况。 |
| HiCollie_ErrorCode OH_HiCollie_Report (bool *isSixSecond) | 上报应用业务线程卡死事件，生成卡死故障日志，辅助定位应用卡死问题。 先调用OH_HiCollie_Init_StuckDetection或OH_HiCollie_Init_StuckDetectionWithTimeout接口，初始化检测的task； 如果task任务超时，结合业务逻辑，调用OH_HiCollie_Report接口上报卡死事件。 |
| HiCollie_ErrorCode OH_HiCollie_SetTimer (HiCollie_SetTimerParam param, int *id) | 注册定时器，用于检测函数或代码块执行是否超过自定义时间。 结合OH_HiCollie_CancelTimer接口配套使用，应在调用耗时的函数之前使用。 |
| void OH_HiCollie_CancelTimer (int id) | 取消定时器。 结合OH_HiCollie_SetTimer接口配套使用，执行函数或代码块后使用，OH_HiCollie_CancelTimer通过id将该任务取消； 若未在自定义时间内取消，则执行回调函数，在特定自定义超时动作下，生成故障日志。 |
你可能感兴趣的鸿蒙文章
harmony 鸿蒙Performance Analysis Kit（性能分析服务）
harmony 鸿蒙HiAppEvent_AppEventGroup
harmony 鸿蒙HiAppEvent_AppEventInfo
harmony 鸿蒙HiCollie_DetectionParam
harmony 鸿蒙HiCollie_SetTimerParam
0
赞
热门推荐
-
2、 - 优质文章
-
3、 gate.io
-
8、 golang
-
9、 openharmony
-
10、 Vue中input框自动聚焦