获取进程相关的信息

说明： 从 API Version 7 开始支持。

导入模块

import process from '@ohos.process';

权限

无

属性

ChildProcess

主进程可以获取子进程的标准输入输出，以及发送信号和关闭子进程。

属性

wait

wait(): Promise<number>

等待子进程运行结束，返回promise对象，其值为子进程的退出码。

• 返回值：

  类型	说明
  Promise<number>	异步返回子进程的退出码。

• 示例：

  import process from '@ohos.process';
  var child = process.runCmd('ls');
  var result = child.wait();
  result.then(val=>{
      console.log("result = " + val);
  })

getOutput

getOutput(): Promise<Uint8Array>

获取子进程的标准输出。

• 返回值：

  类型	说明
  Promise<Uint8Array>	异步返回标准输出的字节流。

• 示例：

  import process from '@ohos.process';
  var child = process.runCmd('ls');
  var result = child.wait();
  child.getOutput.then(val=>{
      console.log("child.getOutput = " + val);
  })

getErrorOutput

getErrorOutput(): Promise<Uint8Array>

getErrorOutput函数用来获取子进程的标准错误输出。

• 返回值：

  类型	说明
  Promise<Uint8Array>	异步返回标准错误输出的字节流。

• 示例：

  import process from '@ohos.process';
  var child = process.runCmd('madir test.text');
  var result = child.wait();
  child.getErrorOutput.then(val=>{
      console.log("child.getErrorOutput= " + val);
  })

close

close(): void

关闭正在运行的子进程。

• 示例：

  import process from '@ohos.process';
  var child = process.runCmd('sleep 5; ls');
  child.close();

kill

kill(signal: number | string): void

kill函数用来发送信号给子进程，结束指定进程。

• 参数：

  参数名	类型	必填	说明
  signal	number | string	是	数字或字符串。

• 示例：

  import process from '@ohos.process';
  var child = process.runCmd('sleep 5; ls');
  child.kill(9);

process.runCmd

runCmd(command: string, options?: { timeout : number, killSignal ：number | string, maxBuffer : number }) : ChildProcess

通过runcmd可以fork一个新的进程来运行一段shell，并返回ChildProcess对象。

• 参数：

  参数名	类型	必填	说明
  command	string	是	shell命令。
  options	Object	否	相关选项参数。

  表 1 options

  名称	参数类型	必填	说明
  timeout	number	否	子进程运行的ms数，当子进程运行时间超出此时间，则父进程发送killSignal信号给子进程。timeout默认为0。
  killSignal	number | string	否	子进程运行时间超出timeout时，父进程发送killSignal 信号给子进程。killSignal 默认为'SIGTERM'。
  maxBuffer	number	否	子进程标准输入输出的最大缓冲区大小，当超出此大小时则终止子进程。maxBuffer默认1024*1024。

• 返回值：

  类型	说明
  ChildProcess	子进程对象。

• 示例：

  import process from '@ohos.process';
  var child = process.runCmd('ls', { maxBuffer : 2 });
  var result = child.wait();
  child.getOutput.then(val=>{
      console.log("child.getOutput = " + val);
  }

process.abort

abort(): void

该方法会导致进程立即退出并生成一个核心文件，谨慎使用。

• 示例：

  import process from '@ohos.process';
  process.abort();

process.on

on(type: string, listener: EventListener): void

用该方法来存储用户所触发的事件。

• 参数：

  参数名	类型	必填	说明
  type	string	是	存储事件的type。
  listener	EventListener	是	回调的事件。

  表 2 EventListener

  名称	说明
  EventListener = (evt: Object) => void	用户存储的事件。

• 示例：

  import process from '@ohos.process';
  process.on("data", (e)=>{
      console.log("data callback");
  })

process.off

off(type: string): boolean

用该方法来删除用户存储的事件。

• 参数：

  参数名	类型	必填	说明
  type	string	是	删除事件的type。

• 返回值：

  类型	说明
  boolean	事件是否删除成功。

• 示例：

  import process from '@ohos.process';
  process.on("data", (e)=>{
      console.log("data callback");
  })
  var result = process.off("data");

process.exit

exit(code: number): void

用该方法终止程序，谨慎使用。

• 参数：

  参数名	类型	必填	说明
  code	number	是	进程的退出码。

• 示例：

  import process from '@ohos.process';
  process.exit(0);

process.cwd

cwd(): string

用该方法获取进程的工作目录。

• 示例：

  import process from '@ohos.process';
  var path = process.cwd();

process.chdir

chdir(dir: string): void

用该方法更改进程的当前工作目录。

• 参数：

  参数名	类型	必填	说明
  dir	string	是	路径。

• 示例：

  import process from '@ohos.process';
  process.chdir('/system');

process.uptime

uptime(): number

获取当前系统已运行的秒数。

• 返回值：

  类型	说明
  number	当前系统已运行的秒数。

• 示例：

  import process from '@ohos.process';
  var time = process.uptime();

process.kill

kill(pid: number，signal: number ): boolean

用该方法发送signal到指定的进程，结束指定进程。

• 参数：

  参数名	类型	必填	说明
  pid	number	是	进程的id。
  signal	number	是	发送的信号。

• 返回值：

  类型	说明
  boolean	信号是否发送成功。

• 示例：

  import process from '@ohos.process'
  var pres = process.pid
  var result = that.kill(pres, 28)