オブジェクト組み込みオブジェクト

オブジェクトChildProcess

子プロセスオブジェクト

1 2
var child_process = require("child_process"); var child = child_process.spawn("ls");

継承

#lineWidth: 1.5 #font: Helvetica,sans-Serif #fontSize: 10 #leading: 1.6 #.this: fill=lightgray #.class: fill=white [<class>object|toString();toJSON()] [<class>EventEmitter|new EventEmitter()|EventEmitter|defaultMaxListeners|on();addListener();prependListener();once();prependOnceListener();off();removeListener();removeAllListeners();setMaxListeners();getMaxListeners();listeners();listenerCount();eventNames();emit()] [<this>ChildProcess|pid;exitCode;stdin;stdout;stderr;onexit|kill();join();usage()] [object] <:- [EventEmitter] [EventEmitter] <:- [ChildProcess] EventEmitter new EventEmitter() EventEmitter defaultMaxListeners on() addListener() prependListener() once() prependOnceListener() off() removeListener() removeAllListeners() setMaxListeners() getMaxListeners() listeners() listenerCount() eventNames() emit() ChildProcess pid exitCode stdin stdout stderr onexit kill() join() usage() object toString() toJSON()

静的プロパティ

defaultMaxListeners

整数、リスナーのデフォルトのグローバル最大数

1
static Integer ChildProcess.defaultMaxListeners;

メンバー属性

pid

整数、現在のオブジェクトが指すプロセスのIDを読み取ります

1
readonly Integer ChildProcess.pid;

exitCode

現在のプロセスの終了コードを整数、クエリ、および設定します

1
readonly Integer ChildProcess.exitCode;

stdin

Stream、現在のオブジェクトが指すプロセスの標準入力オブジェクトを読み取ります

1
readonly Stream ChildProcess.stdin;

stdout

Stream、現在のオブジェクトが指すプロセスの標準出力オブジェクトを読み取ります

1
readonly Stream ChildProcess.stdout;

stderr

Stream、現在のオブジェクトが指すプロセスの標準エラーオブジェクトを読み取ります

1
readonly Stream ChildProcess.stderr;

onexit

on( "exit"、func);と同等の関数、クエリ、およびバインドプロセスの終了イベント。

1
Function ChildProcess.onexit;

メンバー関数

kill

現在のオブジェクトが指すプロセスを強制終了し、シグナルを渡します

1
ChildProcess.kill(Integer signal);

呼び出しパラメーター:

  • signal:整数、渡された信号

現在のオブジェクトが指すプロセスを強制終了し、シグナルを渡します

1
ChildProcess.kill(String signal);

呼び出しパラメーター:

  • signal:文字列、渡された信号

join

現在のオブジェクトが指すプロセスの終了を待ち、プロセス終了コードを返します

1
ChildProcess.join() async;

戻り結果:

  • プロセスの終了コード

usage

現在のプロセスで費やされたメモリと時間をクエリします

1
Object ChildProcess.usage();

戻り結果:

  • Object、時間を含むレポートを返す

メモリレポートは、次のような結果を生成します。

1 2 3 4 5
{ "user": 132379, "system": 50507, "rss": 8622080 }

の:

  • ユーザーは、プロセスに費やされた時間をユーザーコードでマイクロ秒(100万分の1秒)単位で返します。
  • システムは、プロセスによって費やされた時間をマイクロ秒(100万分の1秒)単位でシステムコードに返します。
  • rssは、プロセスが現在占有している物理メモリのサイズを返します

on

イベントハンドラーをオブジェクトにバインドします

1 2
Object ChildProcess.on(String ev, Function func);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します
  • func:関数、イベント処理関数を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

イベントハンドラーをオブジェクトにバインドします

1
Object ChildProcess.on(Object map);

呼び出しパラメーター:

  • map:オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます。

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

addListener

イベントハンドラーをオブジェクトにバインドします

1 2
Object ChildProcess.addListener(String ev, Function func);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します
  • func:関数、イベント処理関数を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

イベントハンドラーをオブジェクトにバインドします

1
Object ChildProcess.addListener(Object map);

呼び出しパラメーター:

  • map:オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます。

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

prependListener

イベントハンドラーをオブジェクトの先頭にバインドします

1 2
Object ChildProcess.prependListener(String ev, Function func);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します
  • func:関数、イベント処理関数を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

イベントハンドラーをオブジェクトの先頭にバインドします

1
Object ChildProcess.prependListener(Object map);

呼び出しパラメーター:

  • map:オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます。

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

once

ワンタイムイベント処理関数をオブジェクトにバインドします。ワンタイム処理関数は1回だけトリガーされます

1 2
Object ChildProcess.once(String ev, Function func);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します
  • func:関数、イベント処理関数を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

ワンタイムイベント処理関数をオブジェクトにバインドします。ワンタイム処理関数は1回だけトリガーされます

1
Object ChildProcess.once(Object map);

呼び出しパラメーター:

  • map:オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます。

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

prependOnceListener

イベントハンドラーをオブジェクトの先頭にバインドします

1 2
Object ChildProcess.prependOnceListener(String ev, Function func);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します
  • func:関数、イベント処理関数を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

イベントハンドラーをオブジェクトの先頭にバインドします

1
Object ChildProcess.prependOnceListener(Object map);

呼び出しパラメーター:

  • map:オブジェクト、イベントマッピング関係を指定します。オブジェクトのプロパティ名はイベント名として使用され、プロパティ値はイベント処理関数として使用されます。

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

off

指定された機能をオブジェクト処理キューからキャンセルします

1 2
Object ChildProcess.off(String ev, Function func);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します
  • func:関数、イベント処理関数を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

オブジェクト処理キュー内のすべての機能をキャンセルします

1
Object ChildProcess.off(String ev);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

指定された機能をオブジェクト処理キューからキャンセルします

1
Object ChildProcess.off(Object map);

呼び出しパラメーター:

  • map:オブジェクト、イベントマッピング関係を指定し、オブジェクトのプロパティ名をイベント名として使用し、プロパティ値をイベント処理関数として使用します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

removeListener

指定された機能をオブジェクト処理キューからキャンセルします

1 2
Object ChildProcess.removeListener(String ev, Function func);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します
  • func:関数、イベント処理関数を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

オブジェクト処理キュー内のすべての機能をキャンセルします

1
Object ChildProcess.removeListener(String ev);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

指定された機能をオブジェクト処理キューからキャンセルします

1
Object ChildProcess.removeListener(Object map);

呼び出しパラメーター:

  • map:オブジェクト、イベントマッピング関係を指定し、オブジェクトのプロパティ名をイベント名として使用し、プロパティ値をイベント処理関数として使用します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

removeAllListeners

オブジェクト処理キューからすべてのイベントのすべてのリスナーをキャンセルします。イベントが指定されている場合は、指定されたイベントのすべてのリスナーを削除します。

1
Object ChildProcess.removeAllListeners(String ev);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

オブジェクト処理キューからすべてのイベントのすべてのリスナーをキャンセルします。イベントが指定されている場合は、指定されたイベントのすべてのリスナーを削除します。

1
Object ChildProcess.removeAllListeners(Array evs = []);

呼び出しパラメーター:

  • evs:配列、イベントの名前を指定します

戻り結果:

  • Object、チェーン呼び出しに便利なイベントオブジェクト自体を返します

setMaxListeners

互換性のためだけの、リスナー数のデフォルト制限

1
ChildProcess.setMaxListeners(Integer n);

呼び出しパラメーター:

  • n:整数、イベント数を指定

getMaxListeners

互換性のためにのみ、リスナー数のデフォルト制限を取得します

1
Integer ChildProcess.getMaxListeners();

戻り結果:

  • Integer、デフォルトの制限数に戻ります

listeners

クエリオブジェクトの指定されたイベントのリスナーの配列

1
Array ChildProcess.listeners(String ev);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します

戻り結果:

  • Array、指定されたイベントのリスナーの配列を返します

listenerCount

クエリオブジェクトの指定されたイベントのリスナーの数

1
Integer ChildProcess.listenerCount(String ev);

呼び出しパラメーター:

  • ev:文字列、イベントの名前を指定します

戻り結果:

  • Integer、指定されたイベントのリスナーの数を返します

クエリオブジェクトの指定されたイベントのリスナーの数

1 2
Integer ChildProcess.listenerCount(Value o, String ev);

呼び出しパラメーター:

  • o:値、クエリのオブジェクトを指定します
  • ev:文字列、イベントの名前を指定します

戻り結果:

  • Integer、指定されたイベントのリスナーの数を返します

eventNames

リスナーのイベント名を照会します

1
Array ChildProcess.eventNames();

戻り結果:

  • Array、イベント名の配列を返します

emit

イベントを積極的にトリガーする

1 2
Boolean ChildProcess.emit(String ev, ...args);

呼び出しパラメーター:

  • ev:文字列、イベント名
  • args:...、イベントパラメータ。イベントハンドラに渡されます。

戻り結果:

  • Boolean、イベントトリガー状態に戻ります。応答イベントがある場合はtrueを返し、それ以外の場合はfalseを返します。

toString

オブジェクトの文字列表現を返します。通常は「[NativeObject]」を返します。オブジェクトは、独自の特性に従って再実装できます。

1
String ChildProcess.toString();

戻り結果:

  • String、オブジェクトの文字列表現を返します

toJSON

オブジェクトのJSON形式の表現を返します。通常、オブジェクトによって定義された読み取り可能な属性のコレクションを返します。

1
Value ChildProcess.toJSON(String key = "");

呼び出しパラメーター:

  • key:文字列、未使用

戻り結果:

  • Value、シリアル化可能なJSONを含む値を返します