native_child_process.h
概述
支持创建Native子进程，并在父子进程间建立IPC通道。
通过此模块和childProcessManager（非SELF_FORK模式）可以启动的子进程总数最大为512个。
引用文件： <AbilityKit/native_child_process.h>
库： libchild_process.so
系统能力： SystemCapability.Ability.AbilityRuntime.Core
起始版本： 12
相关模块： ChildProcess
汇总
结构体
| 名称 | typedef关键字 | 描述 |
|---|---|---|
| NativeChildProcess_Fd | NativeChildProcess_Fd | 传递给子进程的文件描述符信息。 |
| NativeChildProcess_FdList | NativeChildProcess_FdList | 传递给子进程的文件描述符信息列表。文件描述符记录个数不能超过16个。 |
| NativeChildProcess_Options | NativeChildProcess_Options | 子进程所使用的选项。 |
| NativeChildProcess_Args | NativeChildProcess_Args | 传递给子进程的参数。 |
| Ability_ChildProcessConfigs | Ability_ChildProcessConfigs | 启动子进程的配置信息，包括子进程的进程名、以及数据沙箱与网络环境的共享模式。 |
枚举
| 名称 | typedef关键字 | 描述 |
|---|---|---|
| Ability_NativeChildProcess_ErrCode | Ability_NativeChildProcess_ErrCode | 定义Native子进程模块错误码。 |
| NativeChildProcess_IsolationMode | NativeChildProcess_IsolationMode | 定义Native子进程数据沙箱与网络环境的共享模式。 |
函数
| 名称 | typedef关键字 | 描述 |
|---|---|---|
| Ability_ChildProcessConfigs* OH_Ability_CreateChildProcessConfigs() | - | 创建一个子进程配置信息对象。创建对象成功后需要通过调用OH_Ability_DestroyChildProcessConfigs来销毁对象从而避免内存泄漏。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_DestroyChildProcessConfigs(Ability_ChildProcessConfigs* configs) | - | 销毁一个子进程配置信息对象，并释放其内存，在调用该接口后，要避免继续使用已销毁的configs对象。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetIsolationMode(Ability_ChildProcessConfigs* configs, NativeChildProcess_IsolationMode isolationMode) | - | 设置子进程配置信息对象的数据沙箱与网络环境的共享模式，详见NativeChildProcess_IsolationMode。该设置仅当调用OH_Ability_StartNativeChildProcessWithConfigs、OH_Ability_CreateNativeChildProcessWithConfigs接口时生效。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetProcessName(Ability_ChildProcessConfigs* configs,const char* processName) | - | 设置子进程配置信息对象中的进程名称。 |
| typedef void (*OH_Ability_OnNativeChildProcessStarted)(int errCode, OHIPCRemoteProxy *remoteProxy) | OH_Ability_OnNativeChildProcessStarted | 根据传入的子进程配置信息创建子进程，并加载参数中指定的动态链接库文件。子进程的启动结果通过回调参数异步通知调用方。该回调在独立线程中执行，需要确保线程同步，且不能执行高耗时操作避免长时间阻塞。 |
| int OH_Ability_CreateNativeChildProcess(const char* libName,OH_Ability_OnNativeChildProcessStarted onProcessStarted) | - | 创建子进程并加载参数中指定的动态链接库文件，进程启动结果通过回调参数异步通知，需注意回调通知为独立线程，回调函数实现需要注意线程同步，且不能执行高耗时操作避免长时间阻塞。参数所指定的动态库必须实现并导出下列函数： 1. OHIPCRemoteStub* NativeChildProcess_OnConnect() 2. void NativeChildProcess_MainProc() 处理逻辑顺序如下列伪代码所示： 主进程： 1. OH_Ability_CreateNativeChildProcess(libName, onProcessStartedCallback) 子进程： 2. dlopen(libName) 3. dlsym("NativeChildProcess_OnConnect") 4. dlsym("NativeChildProcess_MainProc") 5. ipcRemote = NativeChildProcess_OnConnect() 6. NativeChildProcess_MainProc() 主进程： 7. onProcessStartedCallback(ipcRemote, errCode) 子进程： 8. 在NativeChildProcess_MainProc()函数返回后子进程退出。 设备行为差异： 对于API 13及之前版本，该接口在PC/2in1中可正常使用，在其他设备中返回NCP_ERR_NOT_SUPPORTED错误码。对于API 14及之后版本，该接口在PC/2in1、Tablet设备可正常使用，在其他设备中返回NCP_ERR_NOT_SUPPORTED错误码。 说明： 对于API 14及之前版本，单个进程只能启动1个Native子进程。从API 15开始，单个进程最多支持启动50个Native子进程。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_CreateNativeChildProcessWithConfigs(const char* libName,Ability_ChildProcessConfigs* configs, OH_Ability_OnNativeChildProcessStarted onProcessStarted) | - | 根据传入的子进程配置信息创建子进程，并加载参数中指定的动态链接库文件。子进程的启动结果通过回调参数异步通知调用方。该回调在独立线程中执行，需要确保线程同步，且不能执行高耗时操作避免长时间阻塞。参数所指定的动态库必须实现并导出下列函数： 1. OHIPCRemoteStub* NativeChildProcess_OnConnect() 2. void NativeChildProcess_MainProc() 处理逻辑顺序如下列伪代码所示： 主进程： 1. OH_Ability_CreateNativeChildProcessWithConfigs(libName, configs, onProcessStartedCallback) 子进程： 2. dlopen(libName) 3. dlsym("NativeChildProcess_OnConnect") 4. dlsym("NativeChildProcess_MainProc") 5. ipcRemote = NativeChildProcess_OnConnect() 6. NativeChildProcess_MainProc() 主进程： 7. onProcessStartedCallback(ipcRemote, errCode) 子进程： 8. 在NativeChildProcess_MainProc()函数返回后子进程退出。 设备行为差异： 该接口在PC/2in1、Tablet设备中可正常调用，在其他设备中返回NCP_ERR_NOT_SUPPORTED错误码。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcess(const char* entry, NativeChildProcess_Args args,NativeChildProcess_Options options, int32_t *pid) | - | 启动一个子进程，并加载指定的动态链接库文件。指定的动态库必须实现一个以NativeChildProcess_Args为参数的函数（函数名称可自定义），并导出该函数。示例如下： 1. void Main(NativeChildProcess_Args args); 处理逻辑顺序如下列伪代码所示： 主进程： 1. OH_Ability_StartNativeChildProcess(entryPoint, args, options) 子进程： 2. dlopen(libName) 3. dlsym("Main") 4. Main(args) 5. 子进程将在Main(args)函数返回后退出。 设备行为差异： 对于API 13及之前版本，该接口在PC/2in1设备中可正常使用，在其他设备类型中返回NCP_ERR_NOT_SUPPORTED错误码。对于API 14及之后版本，该接口在PC/2in1、Tablet中可正常使用，在其他设备类型中返回NCP_ERR_NOT_SUPPORTED错误码。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcessWithConfigs(const char* entry, NativeChildProcess_Args args, Ability_ChildProcessConfigs* configs, int32_t *pid) | - | 根据参数中子进程配置信息启动Native子进程，加载参数中指定的动态链接库文件并调用入口函数。支持传参到子进程。指定的动态库必须实现一个以NativeChildProcess_Args为参数的函数（函数名称可自定义），并导出该函数。示例如下： 1. void Main(NativeChildProcess_Args args); 处理逻辑顺序如下列伪代码所示： 主进程： 1. OH_Ability_StartNativeChildProcessWithConfigs(entryPoint, args, configs, &pid) 子进程： 2. dlopen(libName) 3. dlsym("Main") 4. Main(args) 5. 子进程将在Main(args)函数返回后退出。 设备行为差异： 该接口在PC/2in1、Tablet设备中可正常调用，在其他设备中返回NCP_ERR_NOT_SUPPORTED错误码。 |
| NativeChildProcess_Args* OH_Ability_GetCurrentChildProcessArgs() | - | 子进程获取自身的启动参数。 |
| typedef void (*OH_Ability_OnNativeChildProcessExit)(int32_t pid, int32_t signal) | OH_Ability_OnNativeChildProcessExit | 获取子进程退出信息。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_RegisterNativeChildProcessExitCallback(OH_Ability_OnNativeChildProcessExit onProcessExit) | - | 注册子进程退出回调。重复注册同一个回调函数只会保留一个。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_UnregisterNativeChildProcessExitCallback(OH_Ability_OnNativeChildProcessExit onProcessExit) | - | 解注册子进程退出回调。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetIsolationUid(Ability_ChildProcessConfigs* configs, bool enableIsolationUid) | - | 设置子进程配置信息对象的uid是否隔离。该设置仅在NativeChildProcess_IsolationMode为NCP_ISOLATION_MODE_ISOLATED时生效。 |
| Ability_NativeChildProcess_ErrCode OH_Ability_KillChildProcess(int32_t pid)) | - | 终止当前进程创建的子进程。 |
枚举类型说明
Ability_NativeChildProcess_ErrCode
enum Ability_NativeChildProcess_ErrCode
描述
定义Native子进程模块错误码。
起始版本： 12
| 枚举项 | 描述 |
|---|---|
| NCP_NO_ERROR = 0 | 操作成功。 |
| NCP_ERR_INVALID_PARAM = 401 | 无效参数。 |
| NCP_ERR_NOT_SUPPORTED = 801 | 不支持创建Native子进程。 |
| NCP_ERR_INTERNAL = 16000050 | 内部错误。 |
| NCP_ERR_BUSY = 16010001 | 在Native子进程的启动过程中不能再次创建新的子进程，可以等待当前子进程启动完成后再次尝试。从API version 15开始被废弃。 |
| NCP_ERR_TIMEOUT = 16010002 | 启动Native子进程超时。 |
| NCP_ERR_SERVICE_ERROR = 16010003 | 服务端出错。 |
| NCP_ERR_MULTI_PROCESS_DISABLED = 16010004 | 多进程模式已关闭，不允许启动子进程。 |
| NCP_ERR_ALREADY_IN_CHILD = 16010005 | 不允许在子进程中再次创建进程。 |
| NCP_ERR_MAX_CHILD_PROCESSES_REACHED = 16010006 | 到达最大Native子进程数量限制，不能再创建子进程。 |
| NCP_ERR_LIB_LOADING_FAILED = 16010007 | 子进程加载动态库失败，文件不存在或者未实现对应的方法并导出。 |
| NCP_ERR_CONNECTION_FAILED = 16010008 | 子进程调用动态库的OnConnect方法失败，可能返回了无效的IPC对象指针。 |
| NCP_ERR_CALLBACK_NOT_EXIST = 16010009 | 父进程调用解注册Native子进程退出回调，未找到注册的回调函数。 起始版本： 20 |
| NCP_ERR_INVALID_PID = 16010010 | 该进程pid不存在，或并非当前进程的子进程pid，或属于childProcessManager.startChildProcess接口在SELF_FORK模式下启动的子进程。 起始版本： 22 |
NativeChildProcess_IsolationMode
enum NativeChildProcess_IsolationMode
描述
定义Native子进程数据沙箱与网络环境的共享模式。
起始版本： 13
| 枚举项 | 描述 |
|---|---|
| NCP_ISOLATION_MODE_NORMAL = 0 | 普通隔离模式下，父进程与子进程共享同一沙箱环境或网络环境。 |
| NCP_ISOLATION_MODE_ISOLATED = 1 | 在隔离模式下，父进程与子进程不共享同一沙箱环境或网络环境。 |
函数说明
OH_Ability_CreateChildProcessConfigs()
Ability_ChildProcessConfigs* OH_Ability_CreateChildProcessConfigs()
描述
创建一个子进程配置信息对象。创建对象成功后需要通过调用OH_Ability_DestroyChildProcessConfigs来销毁对象从而避免内存泄漏。
起始版本： 20
返回：
| 类型 | 说明 |
|---|---|
| Ability_ChildProcessConfigs* | 返回一个指向Ability_ChildProcessConfigs对象的指针 - 子进程配置信息对象创建成功。 返回nullptr - 发生内部错误或者内存分配失败。 |
OH_Ability_DestroyChildProcessConfigs()
Ability_NativeChildProcess_ErrCode OH_Ability_DestroyChildProcessConfigs(Ability_ChildProcessConfigs* configs)
描述
销毁一个子进程配置信息对象，并释放其内存，在调用该接口后，要避免继续使用已销毁的configs对象。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| Ability_ChildProcessConfigs* configs | 需要销毁的子进程配置信息对象指针。在调用该接口后，对象指针将失效，避免继续使用该指针。允许传入空指针，空指针不会触发任何操作。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 操作成功。 NCP_ERR_INVALID_PARAM - 传入参数为nullptr。 |
OH_Ability_ChildProcessConfigs_SetIsolationMode()
Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetIsolationMode(Ability_ChildProcessConfigs* configs, NativeChildProcess_IsolationMode isolationMode)
描述
设置子进程配置信息对象的数据沙箱与网络环境的共享模式，详见NativeChildProcess_IsolationMode。该设置仅当调用OH_Ability_StartNativeChildProcessWithConfigs、OH_Ability_CreateNativeChildProcessWithConfigs接口时生效。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| Ability_ChildProcessConfigs* configs | 子进程的配置信息对象指针。不可以为空指针。 |
| NativeChildProcess_IsolationMode isolationMode | 要设置的数据沙箱与网络环境的共享模式，详见NativeChildProcess_IsolationMode。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 执行成功。 NCP_ERR_INVALID_PARAM - 传入参数configs为nullptr。 |
OH_Ability_ChildProcessConfigs_SetIsolationUid()
Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetIsolationUid(Ability_ChildProcessConfigs* configs, bool isolationUid)
描述
设置子进程配置信息对象的uid是否隔离。例如用于浏览器的安全加固场景，设置主进程与子进程的uid隔离。
该设置仅在NativeChildProcess_IsolationMode为NCP_ISOLATION_MODE_ISOLATED时生效。不调用该接口设置isolationUid时，则默认为false，即子进程与主进程拥有相同uid。
起始版本： 21
参数：
| 参数项 | 描述 |
|---|---|
| Ability_ChildProcessConfigs* configs | 子进程的配置信息对象指针。不可以为空指针。 |
| bool isolationUid | 控制子进程是否使用独立的uid。true表示子进程拥有独立的uid，false表示子进程与主进程拥有相同uid。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 执行成功。 NCP_ERR_INVALID_PARAM - 传入参数configs为nullptr。 |
OH_Ability_ChildProcessConfigs_SetProcessName()
Ability_NativeChildProcess_ErrCode OH_Ability_ChildProcessConfigs_SetProcessName(Ability_ChildProcessConfigs* configs,const char* processName)
描述
设置子进程配置信息对象中的进程名称。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| Ability_ChildProcessConfigs* configs | 子进程的配置信息对象指针。不能为空指针。 |
| const char* processName | 设置的子进程名字符串必须是非空字符串，并且只能由字母、数字和下划线构成。最大长度为64字符。最终的进程名是{bundleName}:{processName}。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 执行成功。 NCP_ERR_INVALID_PARAM - 传入参数configs为nullptr，或者processName包含除字母、数字、下划线以外的字符。 |
OH_Ability_OnNativeChildProcessStarted()
typedef void (*OH_Ability_OnNativeChildProcessStarted)(int errCode, OHIPCRemoteProxy *remoteProxy)
描述
定义通知子进程启动结果的回调函数。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| int errCode | 回调函数返回的错误码，可用的值如下： NCP_NO_ERROR - 创建子进程成功。 NCP_ERR_LIB_LOADING_FAILED - 加载动态库文件失败或动态库中未实现必要的导出函数。 NCP_ERR_CONNECTION_FAILED - 动态库中实现的OnConnect方法未返回有效的IPC Stub指针。 详见Ability_NativeChildProcess_ErrCode定义。 |
| OHIPCRemoteProxy *remoteProxy | 子进程的IPC对象指针，出现异常时可能为nullptr：使用完毕后需要调用OH_IPCRemoteProxy_Destroy方法释放。 |
参考：
OH_Ability_CreateNativeChildProcess()
int OH_Ability_CreateNativeChildProcess(const char* libName,OH_Ability_OnNativeChildProcessStarted onProcessStarted)
描述
创建子进程并加载参数中指定的动态链接库文件，进程启动结果通过回调参数异步通知，需注意回调通知为独立线程，回调函数实现需要注意线程同步，且不能执行高耗时操作避免长时间阻塞。
参数所指定的动态库必须实现并导出下列函数：
1. OHIPCRemoteStub* NativeChildProcess_OnConnect()
2. void NativeChildProcess_MainProc()
处理逻辑顺序如下列伪代码所示：
主进程：
1. OH_Ability_CreateNativeChildProcess(libName, onProcessStartedCallback)
子进程：
2. dlopen(libName)
3. dlsym("NativeChildProcess_OnConnect")
4. dlsym("NativeChildProcess_MainProc")
5. ipcRemote = NativeChildProcess_OnConnect()
6. NativeChildProcess_MainProc()
主进程：
7. onProcessStartedCallback(ipcRemote, errCode)
子进程：
8. 在NativeChildProcess_MainProc()函数返回后子进程退出。
设备行为差异： 对于API version 13及之前版本，该接口在PC/2in1中可正常使用，在其他设备中返回NCP_ERR_NOT_SUPPORTED错误码。对于API version 14及之后版本，该接口在PC/2in1、Tablet设备可正常使用，在其他设备中返回NCP_ERR_NOT_SUPPORTED错误码。
说明：
API version 14及之前版本，单个进程只能启动1个Native子进程。从API version 15开始，单个进程最多支持启动50个Native子进程。
起始版本： 12
参数：
| 参数项 | 描述 |
|---|---|
| const char* libName | 子进程中加载的动态库文件名称，不能为nullptr。 |
| OH_Ability_OnNativeChildProcessStarted onProcessStarted | 通知子进程启动结果的回调函数指针，不能为nullptr。详见OH_Ability_OnNativeChildProcessStarted。 |
返回：
| 类型 | 说明 |
|---|---|
| int | NCP_NO_ERROR - 调用成功，但子进程的实际启动结果由回调函数通知。 NCP_ERR_INVALID_PARAM - 无效的动态库名称或者回调函数指针。 NCP_ERR_NOT_SUPPORTED - 当前设备不支持创建Native子进程。 NCP_ERR_MULTI_PROCESS_DISABLED - 当前设备已关闭多进程模式。 NCP_ERR_ALREADY_IN_CHILD - 不允许在子进程中再次创建子进程。 NCP_ERR_MAX_CHILD_PROCESSES_REACHED - 到达最大Native子进程数限制。 详见Ability_NativeChildProcess_ErrCode定义。 |
参考：
OH_Ability_OnNativeChildProcessStarted
OH_Ability_CreateNativeChildProcessWithConfigs()
Ability_NativeChildProcess_ErrCode OH_Ability_CreateNativeChildProcessWithConfigs(const char* libName,Ability_ChildProcessConfigs* configs, OH_Ability_OnNativeChildProcessStarted onProcessStarted)
描述
根据传入的子进程配置信息创建子进程，并加载参数中指定的动态链接库文件。子进程的启动结果通过回调参数异步通知调用方。该回调在独立线程中执行，需要确保线程同步，且不能执行高耗时操作避免长时间阻塞。
参数所指定的动态库必须实现并导出下列函数：
1. OHIPCRemoteStub* NativeChildProcess_OnConnect()
2. void NativeChildProcess_MainProc()
处理逻辑顺序如下列伪代码所示：
主进程：
1. OH_Ability_CreateNativeChildProcessWithConfigs(libName, configs, onProcessStartedCallback)
子进程：
2. dlopen(libName)
3. dlsym("NativeChildProcess_OnConnect")
4. dlsym("NativeChildProcess_MainProc")
5. ipcRemote = NativeChildProcess_OnConnect()
6. NativeChildProcess_MainProc()
主进程：
7. onProcessStartedCallback(ipcRemote, errCode)
子进程：
8. 在NativeChildProcess_MainProc()函数返回后子进程退出。
设备行为差异： 该接口在PC/2in1、Tablet设备中可正常调用，在其他设备中返回NCP_ERR_NOT_SUPPORTED错误码。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| const char* libName | 子进程中加载的动态库文件名称，不能为nullptr。 |
| Ability_ChildProcessConfigs* configs | 子进程的配置信息参数，不能为nullptr。 |
| OH_Ability_OnNativeChildProcessStarted onProcessStarted | 通知子进程启动结果的回调函数指针，不能为nullptr，详见OH_Ability_OnNativeChildProcessStarted。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 执行成功。 NCP_ERR_INVALID_PARAM - 传入参数无效。 NCP_ERR_NOT_SUPPORTED - 当前设备不支持创建Native子进程。 NCP_ERR_MULTI_PROCESS_DISABLED - 当前设备已关闭多进程模式，不允许启动子进程。 NCP_ERR_ALREADY_IN_CHILD - 不允许在子进程中再次创建子进程。 NCP_ERR_MAX_CHILD_PROCESSES_REACHED - 超过最大Native子进程数限制。 详见Ability_NativeChildProcess_ErrCode定义。 |
参考：
OH_Ability_OnNativeChildProcessStarted
OH_Ability_StartNativeChildProcess()
Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcess(const char* entry, NativeChildProcess_Args args,NativeChildProcess_Options options, int32_t *pid)
描述
启动Native子进程，并加载参数中指定的动态链接库文件并调用入口函数。指定的动态库必须实现一个以NativeChildProcess_Args为参数的函数（函数名称可自定义），并导出该函数。支持传参到子进程。子进程中不支持创建ArkTS基础运行时环境。
示例如下：
void Main(NativeChildProcess_Args args);
处理逻辑顺序如下列伪代码所示：
主进程：
1. OH_Ability_StartNativeChildProcess(entryPoint, args, options)
子进程：
2. dlopen(libName)
3. dlsym("Main")
4. Main(args)
5. 子进程将在Main(args)函数返回后退出。
设备行为差异： 对于API 13及之前版本，该接口在PC/2in1设备中可正常使用，在其他设备类型中返回NCP_ERR_NOT_SUPPORTED错误码。对于API 14及之后版本，该接口在PC/2in1、Tablet中可正常使用，在其他设备类型中返回NCP_ERR_NOT_SUPPORTED错误码。
起始版本： 13
参数：
| 参数项 | 描述 |
|---|---|
| const char* entry | 子进程中加载的动态库及入口函数，例如"libEntry.so:Main"，不能为nullptr。 |
| NativeChildProcess_Args args | 传递给子进程的参数。 |
| NativeChildProcess_Options options | 子进程选项。 |
| int32_t *pid | 启动的子进程id。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 调用成功。 NCP_ERR_INVALID_PARAM - 无效的动态库名称或者回调函数指针。 NCP_ERR_NOT_SUPPORTED - 当前设备不支持创建Native子进程。 NCP_ERR_ALREADY_IN_CHILD - 当前设备已关闭多进程模式。 NCP_ERR_MAX_CHILD_PROCESSES_REACHED - 到达最大Native子进程数限制。 详见Ability_NativeChildProcess_ErrCode定义。 |
参考：
OH_Ability_OnNativeChildProcessStarted
OH_Ability_StartNativeChildProcessWithConfigs()
Ability_NativeChildProcess_ErrCode OH_Ability_StartNativeChildProcessWithConfigs(const char* entry, NativeChildProcess_Args args, Ability_ChildProcessConfigs* configs, int32_t *pid)
描述
根据参数中子进程配置信息启动Native子进程，加载参数中指定的动态链接库文件并调用入口函数。支持传参到子进程。指定的动态库必须实现一个以NativeChildProcess_Args为参数的函数（函数名称可自定义），并导出该函数。
示例如下：
void Main(NativeChildProcess_Args args);
处理逻辑顺序如下列伪代码所示：
主进程：
1. OH_Ability_StartNativeChildProcessWithConfigs(entryPoint, args, configs, &pid)
子进程：
2. dlopen(libName)
3. dlsym("Main")
4. Main(args)
5. 子进程将在Main(args)函数返回后退出。
设备行为差异： 该接口在PC/2in1、Tablet中可正常调用，在其他设备类型中返回NCP_ERR_NOT_SUPPORTED错误码。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| const char* entry | 子进程中调用动态库的符号和入口函数，中间用“:”隔开（例如“libentry.so:Main”），不能为nullptr。 |
| NativeChildProcess_Args args | 传给子进程的参数。 |
| Ability_ChildProcessConfigs* configs | 子进程的配置信息参数。 |
| int32_t *pid | 被启动的子进程号。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 执行成功。 NCP_ERR_INVALID_PARAM - 传入参数无效。 NCP_ERR_NOT_SUPPORTED - 当前设备不支持创建Native子进程。 NCP_ERR_ALREADY_IN_CHILD - 不允许在子进程中再次创建子进程。 NCP_ERR_MAX_CHILD_PROCESSES_REACHED - 超过最大Native子进程数限制。 详见Ability_NativeChildProcess_ErrCode定义。 |
OH_Ability_GetCurrentChildProcessArgs()
NativeChildProcess_Args* OH_Ability_GetCurrentChildProcessArgs()
描述
通过OH_Ability_StartNativeChildProcess启动子进程后，子进程能够在任意so和任意子线程中获取启动参数NativeChildProcess_Args。
起始版本： 17
返回：
| 类型 | 说明 |
|---|---|
| NativeChildProcess_Args* | 返回指向当前子进程启动参数的指针。 |
OH_Ability_OnNativeChildProcessExit()
typedef void (*OH_Ability_OnNativeChildProcessExit)(int32_t pid, int32_t signal)
描述
感知Native子进程退出的回调函数。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| int32_t pid | 启动的子进程id。 |
| int32_t signal | 子进程退出信号。 |
参见：
OH_Ability_RegisterNativeChildProcessExitCallback
OH_Ability_UnregisterNativeChildProcessExitCallback
OH_Ability_RegisterNativeChildProcessExitCallback()
Ability_NativeChildProcess_ErrCode OH_Ability_RegisterNativeChildProcessExitCallback(OH_Ability_OnNativeChildProcessExit onProcessExit)
描述
注册Native子进程异常退出回调函数，当通过OH_Ability_StartNativeChildProcess和@ohos.app.ability.childProcessManager的startNativeChildProcess启动的子进程异常退出时，调用入口参数的回调函数。当重复注册同一个回调函数时，子进程退出时只会执行一次回调函数。
参数必须实现OH_Ability_OnNativeChildProcessExit入口函数。详见注册Native子进程退出回调。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_Ability_OnNativeChildProcessExit onProcessExit | 子进程退出的回调函数入口，不能为nullptr。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 调用成功。 NCP_ERR_INVALID_PARAM - 参数不合法。 NCP_ERR_INTERNAL - 内部错误。 详见Ability_NativeChildProcess_ErrCode。 |
OH_Ability_UnregisterNativeChildProcessExitCallback()
Ability_NativeChildProcess_ErrCode OH_Ability_UnregisterNativeChildProcessExitCallback(OH_Ability_OnNativeChildProcessExit onProcessExit)
描述
解注册子进程退出回调。
参数必须实现OH_Ability_OnNativeChildProcessExit入口函数。详见解注册Native子进程退出回调。
起始版本： 20
参数：
| 参数项 | 描述 |
|---|---|
| OH_Ability_OnNativeChildProcessExit onProcessExit | 子进程退出的回调函数入口，不能为nullptr。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 调用成功。 NCP_ERR_INVALID_PARAM - 参数不合法。 NCP_ERR_INTERNAL - 内部错误。 NCP_ERR_CALLBACK_NOT_EXIST - 未找到回调函数。 详见Ability_NativeChildProcess_ErrCode。 |
OH_Ability_KillChildProcess()
Ability_NativeChildProcess_ErrCode OH_Ability_KillChildProcess(int32_t pid)
描述
终止当前进程创建的子进程。
说明：
调用该接口无法终止childProcessManager.startChildProcess接口在SELF_FORK模式下启动的子进程。
起始版本： 22
参数：
| 参数项 | 描述 |
|---|---|
| int32_t pid | 要终止的子进程pid。 |
返回：
| 类型 | 说明 |
|---|---|
| Ability_NativeChildProcess_ErrCode | NCP_NO_ERROR - 调用成功。 NCP_ERR_SERVICE_ERROR - 服务端出错。 NCP_ERR_INVALID_PID - 所传入的子进程pid不合法。 详见Ability_NativeChildProcess_ErrCode。 |