1# Subscribing to Freeze Events (C/C++) 2 3## Available APIs 4 5For details about how to use the APIs (such as parameter usage restrictions and value ranges), see [HiAppEvent](../reference/apis-performance-analysis-kit/_hi_app_event.md#hiappevent). 6 7**Subscription APIs** 8 9| API | Description | 10| ------------------------------------------------------------ | -------------------------------------------- | 11| int OH_HiAppEvent_AddWatcher (HiAppEvent_Watcher \*watcher) | Adds a watcher to listen for application events.| 12| int OH_HiAppEvent_RemoveWatcher (HiAppEvent_Watcher *watcher) | Removes a watcher to unsubscribe from application events.| 13 14## How to Develop 15 16The following describes how to subscribe to the freeze event triggered by a button click. 17 181. Create a native C++ project and import the **jsoncpp** file to the project. The directory structure is as follows: 19 20 ```yml 21 entry: 22 src: 23 main: 24 cpp: 25 - json: 26 - json.h 27 - json-forwards.h 28 - types: 29 libentry: 30 - index.d.ts 31 - CMakeLists.txt 32 - napi_init.cpp 33 - jsoncpp.cpp 34 ets: 35 - entryability: 36 - EntryAbility.ets 37 - pages: 38 - Index.ets 39 ``` 40 412. In the **CMakeLists.txt** file, add the source file and dynamic libraries. 42 43 ```cmake 44 # Add the jsoncpp.cpp file, which is used to parse the JSON strings in the subscription events. 45 add_library(entry SHARED napi_init.cpp jsoncpp.cpp) 46 # Add libhiappevent_ndk.z.so and libhilog_ndk.z.so (log output). 47 target_link_libraries(entry PUBLIC libace_napi.z.so libhilog_ndk.z.so libhiappevent_ndk.z.so) 48 ``` 49 503. Import the dependency files to the **napi_init.cpp** file, and define **LOG_TAG**. 51 52 ```c++ 53 #include "napi/native_api.h" 54 #include "json/json.h" 55 #include "hilog/log.h" 56 #include "hiappevent/hiappevent.h" 57 58 #undef LOG_TAG 59 #define LOG_TAG "testTag" 60 ``` 61 624. Subscribe to system events. 63 64 - Watcher of the onReceive type: 65 66 In the **napi_init.cpp** file, define the methods related to the watcher of the onReceive type. 67 68 ```c++ 69 // Define a variable to cache the pointer to the created watcher. 70 static HiAppEvent_Watcher *systemEventWatcher; 71 72 static void OnReceive(const char *domain, const struct HiAppEvent_AppEventGroup *appEventGroups, uint32_t groupLen) { 73 for (int i = 0; i < groupLen; ++i) { 74 for (int j = 0; j < appEventGroups[i].infoLen; ++j) { 75 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", appEventGroups[i].appEventInfos[j].domain); 76 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", appEventGroups[i].appEventInfos[j].name); 77 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", appEventGroups[i].appEventInfos[j].type); 78 if (strcmp(appEventGroups[i].appEventInfos[j].domain, DOMAIN_OS) == 0 && 79 strcmp(appEventGroups[i].appEventInfos[j].name, EVENT_APP_FREEZE) == 0) { 80 Json::Value params; 81 Json::Reader reader(Json::Features::strictMode()); 82 Json::FastWriter writer; 83 if (reader.parse(appEventGroups[i].appEventInfos[j].params, params)) { 84 auto time = params["time"].asInt64(); 85 auto foreground = params["foreground"].asBool(); 86 auto bundleVersion = params["bundle_version"].asString(); 87 auto bundleName = params["bundle_name"].asString(); 88 auto processName = params["process_name"].asString(); 89 auto pid = params["pid"].asInt(); 90 auto uid = params["uid"].asInt(); 91 auto uuid = params["uuid"].asString(); 92 auto exception = writer.write(params["exception"]); 93 auto hilogSize = params["hilog"].size(); 94 auto handleSize = params["event_handler"].size(); 95 auto handleSize3s = params["event_handler_size_3s"].asString(); 96 auto handleSize6s = params["event_handler_size_6s"].asString(); 97 auto peerBindSize = params["peer_binder"].size(); 98 auto threadSize = params["threads"].size(); 99 auto memory = writer.write(params["memory"]); 100 auto externalLog = writer.write(params["external_log"]); 101 auto logOverLimit = params["log_over_limit"].asBool(); 102 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time); 103 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.foreground=%{public}d", foreground); 104 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str()); 105 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", bundleName.c_str()); 106 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.process_name=%{public}s", processName.c_str()); 107 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid); 108 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid); 109 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uuid=%{public}s", uuid.c_str()); 110 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.exception=%{public}s", exception.c_str()); 111 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.hilog.size=%{public}d", hilogSize); 112 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.event_handler.size=%{public}d", handleSize); 113 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.event_handler_3s.size=%{public}s", handleSize3s.c_str()); 114 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.event_handler_6s.size=%{public}s", handleSize6s.c_str()); 115 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.peer_binder.size=%{public}d", peerBindSize); 116 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.threads.size=%{public}d", threadSize); 117 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.memory=%{public}s", memory.c_str()); 118 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str()); 119 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}d", logOverLimit); 120 } 121 } 122 } 123 } 124 } 125 126 static napi_value RegisterWatcher(napi_env env, napi_callback_info info) { 127 // Set the watcher name. The system identifies different watchers based on their names. 128 systemEventWatcher = OH_HiAppEvent_CreateWatcher("onReceiverWatcher"); 129 // Set the event to watch to EVENT_APP_FREEZE. 130 const char *names[] = {EVENT_APP_FREEZE}; 131 // Add the events to watch, for example, system events. 132 OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1); 133 // Set the implemented callback. After receiving the event, the watcher immediately triggers the OnReceive callback. 134 OH_HiAppEvent_SetWatcherOnReceive(systemEventWatcher, OnReceive); 135 // Add a watcher to listen for the specified event. 136 OH_HiAppEvent_AddWatcher(systemEventWatcher); 137 return {}; 138 } 139 ``` 140 141 - Watcher of the onTrigger type: 142 143 In the **napi_init.cpp** file, define the methods related to the watcher of the OnTrigger type. 144 145 ```c++ 146 // Define a variable to cache the pointer to the created watcher. 147 static HiAppEvent_Watcher *systemEventWatcher; 148 149 // Implement the callback function used to return the listened events. The content pointed to by the events pointer is valid only in this function. 150 static void OnTake(const char *const *events, uint32_t eventLen) { 151 Json::Reader reader(Json::Features::strictMode()); 152 Json::FastWriter writer; 153 for (int i = 0; i < eventLen; ++i) { 154 Json::Value eventInfo; 155 if (reader.parse(events[i], eventInfo)) { 156 auto domain = eventInfo["domain_"].asString(); 157 auto name = eventInfo["name_"].asString(); 158 auto type = eventInfo["type_"].asInt(); 159 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.domain=%{public}s", domain.c_str()); 160 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.name=%{public}s", name.c_str()); 161 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.eventType=%{public}d", type); 162 if (domain == DOMAIN_OS && name == EVENT_APP_FREEZE) { 163 auto time = eventInfo["time"].asInt64(); 164 auto foreground = eventInfo["foreground"].asBool(); 165 auto bundleVersion = eventInfo["bundle_version"].asString(); 166 auto bundleName = eventInfo["bundle_name"].asString(); 167 auto processName = eventInfo["process_name"].asString(); 168 auto pid = eventInfo["pid"].asInt(); 169 auto uid = eventInfo["uid"].asInt(); 170 auto uuid = eventInfo["uuid"].asString(); 171 auto exception = writer.write(eventInfo["exception"]); 172 auto hilogSize = eventInfo["hilog"].size(); 173 auto handleSize = eventInfo["event_handler"].size(); 174 auto handleSize3s = eventInfo["event_handler_size_3s"].asString(); 175 auto handleSize6s = eventInfo["event_handler_size_6s"].asString(); 176 auto peerBindSize = eventInfo["peer_binder"].size(); 177 auto threadSize = eventInfo["threads"].size(); 178 auto memory = writer.write(eventInfo["memory"]); 179 auto externalLog = writer.write(eventInfo["external_log"]); 180 auto logOverLimit = eventInfo["log_over_limit"].asBool(); 181 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.time=%{public}lld", time); 182 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.foreground=%{public}d", foreground); 183 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_version=%{public}s", bundleVersion.c_str()); 184 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.bundle_name=%{public}s", bundleName.c_str()); 185 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.process_name=%{public}s", processName.c_str()); 186 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.pid=%{public}d", pid); 187 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uid=%{public}d", uid); 188 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.uuid=%{public}s", uuid.c_str()); 189 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.exception=%{public}s", exception.c_str()); 190 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.hilog.size=%{public}d", hilogSize); 191 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.event_handler.size=%{public}d", handleSize); 192 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.event_handler_3s.size=%{public}s", handleSize3s.c_str()); 193 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.event_handler_6s.size=%{public}s", handleSize6s.c_str()); 194 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.peer_binder.size=%{public}d", peerBindSize); 195 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.threads.size=%{public}d", threadSize); 196 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.memory=%{public}s", memory.c_str()); 197 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.external_log=%{public}s", externalLog.c_str()); 198 OH_LOG_INFO(LogType::LOG_APP, "HiAppEvent eventInfo.params.log_over_limit=%{public}d", logOverLimit); 199 } 200 } 201 } 202 } 203 204 // Implement the subscription callback function to apply custom processing to the obtained event logging data. 205 static void OnTrigger(int row, int size) { 206 // After the callback is received, obtain the specified number of received events. 207 OH_HiAppEvent_TakeWatcherData(systemEventWatcher, row, OnTake); 208 } 209 210 static napi_value RegisterWatcher(napi_env env, napi_callback_info info) { 211 // Set the watcher name. The system identifies different watchers based on their names. 212 systemEventWatcher = OH_HiAppEvent_CreateWatcher("onTriggerWatcher"); 213 // Set the event to watch to EVENT_APP_FREEZE. 214 const char *names[] = {EVENT_APP_FREEZE}; 215 // Add the events to watch, for example, system events. 216 OH_HiAppEvent_SetAppEventFilter(systemEventWatcher, DOMAIN_OS, 0, names, 1); 217 // Set the implemented callback function. The callback function will be triggered when the conditions set by OH_HiAppEvent_SetTriggerCondition are met. 218 OH_HiAppEvent_SetWatcherOnTrigger(systemEventWatcher, OnTrigger); 219 // Set the conditions for triggering the subscription callback. For example, trigger this onTrigger callback when the number of new event logs is 1. 220 OH_HiAppEvent_SetTriggerCondition(systemEventWatcher, 1, 0, 0); 221 // Add a watcher to listen for the specified event. 222 OH_HiAppEvent_AddWatcher(systemEventWatcher); 223 return {}; 224 } 225 ``` 226 2275. Register **RegisterWatcher** as an ArkTS API. 228 229 In the **napi_init.cpp** file, register **RegisterWatcher** as an ArkTS API. 230 231 ```c++ 232 static napi_value Init(napi_env env, napi_value exports) 233 { 234 napi_property_descriptor desc[] = { 235 { "registerWatcher", nullptr, RegisterWatcher, nullptr, nullptr, nullptr, napi_default, nullptr } 236 }; 237 napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc); 238 return exports; 239 } 240 ``` 241 242 In the **index.d.ts** file, define the ArkTS API. 243 244 ```typescript 245 export const registerWatcher: () => void; 246 ``` 247 2486. In the **EntryAbility.ets** file, add the following interface invocation to **onCreate()**. 249 250 ```typescript 251 // Import the dependent module. 252 import testNapi from 'libentry.so' 253 254 // Add the interface invocation to onCreate(). 255 // Register the system event watcher at startup. 256 testNapi.registerWatcher(); 257 ``` 258 2597. In the **Index.ets** file, add a button to trigger the freeze event. 260 261 ```typescript 262 Button("appFreeze").onClick(() => { 263 setTimeout(()=>{ 264 while(true) {} 265 }, 1000) 266 }) 267 ``` 268 2698. In DevEco Studio, click the **Run** button to run the project. Then, click the **appfreeze** button to trigger a freeze event. 270 2719. The application crashes. After restarting the application, you can view the following event information in the **Log** window. 272 273 ```text 274 HiAppEvent eventInfo.domain=OS 275 HiAppEvent eventInfo.name=APP_FREEZE 276 HiAppEvent eventInfo.eventType=1 277 HiAppEvent eventInfo.params.time=1502049167732 278 HiAppEvent eventInfo.params.foreground=1 279 HiAppEvent eventInfo.params.bundle_version=1.0.0 280 HiAppEvent eventInfo.params.bundle_name=com.example.myapplication 281 HiAppEvent eventInfo.params.process_name=com.example.myapplication 282 HiAppEvent eventInfo.params.pid=1587 283 HiAppEvent eventInfo.params.uid=20010043 284 HiAppEvent eventInfo.params.uuid=a78a23b20f3dd9730f18a5cfa2304deac1104ac4086755c4a59cf7c72d414e2e 285 HiAppEvent eventInfo.params.exception={"message":"App main thread is not response!","name":"THREAD_BLOCK_6S"} 286 HiAppEvent eventInfo.params.hilog.size=6 287 HiAppEvent eventInfo.params.event_handler.size=16 288 HiAppEvent eventInfo.params.event_handler_3s.size=15 289 HiAppEvent eventInfo.params.event_handler_6s.size=16 290 HiAppEvent eventInfo.params.peer_binder.size=0 291 HiAppEvent eventInfo.params.threads.size=28 292 HiAppEvent eventInfo.params.memory={"pss":0,"rss":0,"sys_avail_mem":1326520,"sys_free_mem":940588,"sys_total_mem":1992340,"vss":0} 293 HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/APP_FREEZE_1502049185239_1587.log"] 294 HiAppEvent eventInfo.params.log_over_limit=0 295 ``` 296 29710. Remove the event watcher. 298 299 ```c++ 300 static napi_value RemoveWatcher(napi_env env, napi_callback_info info) { 301 // Remove the watcher. 302 OH_HiAppEvent_RemoveWatcher(systemEventWatcher); 303 return {}; 304 } 305 ``` 306 30711. Destroy the event watcher. 308 309 ```c++ 310 static napi_value DestroyWatcher(napi_env env, napi_callback_info info) { 311 // Destroy the created watcher and set systemEventWatcher to nullptr. 312 OH_HiAppEvent_DestroyWatcher(systemEventWatcher); 313 systemEventWatcher = nullptr; 314 return {}; 315 } 316 ``` 317