1# 使用扩展的Node-API接口在异步线程中运行和停止事件循环
2
3## 场景介绍
4开发者在自己创建的ArkTS运行环境中调用异步的ArkTS接口时，可以通过使用Node-API中的扩展接口napi_run_event_loop和napi_stop_event_loop来运行和停止ArkTS实例中的事件循环。
5
6## 调用异步的ArkTS接口示例
7调用的ArkTS接口为异步接口时，需要通过扩展接口napi_run_event_loop将异步线程中的事件循环运行起来，底层事件队列中的异步任务将被处理执行。当前Node-API扩展了两种事件循环模式来运行异步线程的事件循环，分别为napi_event_mode_nowait模式和napi_event_mode_default模式。
8如果使用napi_event_mode_nowait模式运行底层事件循环，系统会尝试从底层的事件队列中取出一个任务并处理，完成之后事件循环停止，如果底层的事件队列中没有任务，事件循环会立刻停止，当前的异步线程不会被阻塞；
9如果使用napi_event_mode_default模式来运行底层事件循环，系统会阻塞当前的线程，同时会一直尝试从事件队列中获取任务并执行处理这些任务。如果不想当前线程继续被阻塞，可以使用扩展接口napi_stop_event_loop将正在运行的事件循环停止。
10
11### 示例代码
12- 模块注册
13    ```c++
14    // hello.cpp
15    #include "napi/native_api.h"
16    #include <napi/common.h>
17    #include <pthread.h>
18
19    static napi_value ResolvedCallback(napi_env env, napi_callback_info info)
20    {
21        napi_stop_event_loop(env);
22        return nullptr;
23    }
24
25    static napi_value RejectedCallback(napi_env env, napi_callback_info info)
26    {
27        napi_stop_event_loop(env);
28        return nullptr;
29    }
30
31    static void *RunEventLoopFunc(void *arg)
32    {
33        // 1. 创建ArkTS实例
34        napi_env env;
35        napi_status ret = napi_create_ark_runtime(&env);
36        if (ret != napi_ok) {
37            return nullptr;
38        }
39
40        // 2. 加载自定义的模块
41        napi_value objectUtils;
42        // 'com.example.myapplication' 为当前应用的bundleName
43        ret = napi_load_module_with_info(env, "ets/pages/ObjectUtils", "com.example.myapplication/entry", &objectUtils);
44        if (ret != napi_ok) {
45            return nullptr;
46        }
47
48        // 3. 调用异步SetTimeout接口
49        napi_value setTimeout = nullptr;
50        napi_value promise = nullptr;
51
52        napi_get_named_property(env, objectUtils, "SetTimeout", &setTimeout);
53        napi_call_function(env, objectUtils, setTimeout, 0, nullptr, &promise);
54
55        napi_value theFunc = nullptr;
56        if (napi_get_named_property(env, promise, "then", &theFunc) != napi_ok) {
57            return nullptr;
58        }
59
60        napi_value resolvedCallback = nullptr;
61        napi_value rejectedCallback = nullptr;
62        napi_create_function(env, "resolvedCallback", NAPI_AUTO_LENGTH, ResolvedCallback, nullptr, &resolvedCallback);
63        napi_create_function(env, "rejectedCallback", NAPI_AUTO_LENGTH, RejectedCallback, nullptr, &rejectedCallback);
64        napi_value argv[2] = {resolvedCallback, rejectedCallback};
65        napi_call_function(env, promise, theFunc, 2, argv, nullptr);
66
67        auto flag = reinterpret_cast<bool *>(arg);
68        if (*flag == true) {
69            napi_run_event_loop(env, napi_event_mode_default);
70        } else {
71            // 非阻塞式的处理任务，有可能队列中还没有任务就已经返回了
72            napi_run_event_loop(env, napi_event_mode_nowait);
73        }
74        return nullptr;
75    }
76
77    static napi_value RunEventLoop(napi_env env, napi_callback_info info)
78    {
79        pthread_t tid;
80        size_t argc = 1;
81        napi_value argv[1] = { nullptr };
82        napi_get_cb_info(env, info, &argc, argv, nullptr, nullptr);
83
84        bool flag = false;
85        napi_get_value_bool(env, argv[0], &flag);
86        // 创建异步线程
87        pthread_create(&tid, nullptr, RunEventLoopFunc, &flag);
88        pthread_join(tid, nullptr);
89
90        return nullptr;
91    }
92
93    // 注册模块接口
94    EXTERN_C_START
95    static napi_value Init(napi_env env, napi_value exports)
96    {
97        napi_property_descriptor desc[] = {
98            { "runEventLoop", nullptr, RunEventLoop, nullptr, nullptr, nullptr, napi_default, nullptr }
99        };
100        napi_define_properties(env, exports, sizeof(desc) / sizeof(desc[0]), desc);
101        return exports;
102    }
103    EXTERN_C_END
104
105    static napi_module nativeModule = {
106        .nm_version = 1,
107        .nm_flags = 0,
108        .nm_filename = nullptr,
109        .nm_register_func = Init,
110        .nm_modname = "entry",
111        .nm_priv = nullptr,
112        .reserved = { 0 },
113    };
114
115    extern "C" __attribute__((constructor)) void RegisterEntryModule()
116    {
117        napi_module_register(&nativeModule);
118    }
119    ```
120
121- 接口声明
122    ```ts
123    // index.d.ts
124    export const runEventLoop: (isDefault: boolean) => object;
125    ```
126
127- 编译配置
1281. CMakeLists.txt文件需要按照如下配置
129    ```
130    // CMakeLists.txt
131    # the minimum version of CMake.
132    cmake_minimum_required(VERSION 3.4.1)
133    project(myapplication)
134
135    set(NATIVERENDER_ROOT_PATH ${CMAKE_CURRENT_SOURCE_DIR})
136
137    if(DEFINED PACKAGE_FIND_FILE)
138        include(${PACKAGE_FIND_FILE})
139    endif()
140
141    include_directories(${NATIVERENDER_ROOT_PATH}
142                        ${NATIVERENDER_ROOT_PATH}/include)
143    add_library(entry SHARED hello.cpp)
144    target_link_libraries(entry PUBLIC libace_napi.z.so)
145    ```
1462. 需要在工程的build-profile.json5文件中进行以下配置
147    ```json
148    {
149        "buildOption" : {
150            "arkOptions" : {
151                "runtimeOnly" : {
152                    "sources": [
153                        "./src/main/ets/pages/ObjectUtils.ets"
154                    ]
155                }
156            }
157        }
158    }
159    ```
160- ArkTS代码示例
161    ```ts
162    // index.ets
163    import testNapi from 'libentry.so'
164
165    testNapi.runEventLoop(true);
166    ```
167    ```ts
168    // ets/pages/ObjectUtils.ets
169    export function SetTimeout() : Promise<void> {
170        return new Promise((resolve) => {
171            setTimeout(() => {
172                console.info('set timer delay 1s');
173                // attempt to stop the event loop at napi terminal
174                resolve();
175            }, 1000)
176        })
177    }
178    ```
179