graalvm/elide.runtime.node.childProcess/ChildProcessHandle

ChildProcessHandle

class ChildProcessHandle : AbstractChildProcessHandle, ReadOnlyProxyObject, ChildProcess

Node API: Child Process

Object returned from async process spawn/exec methods which provide access to the underlying child process; the object exposes access to the process pid, stdin, stdout, stderr, and terminal exit information, in the form of an exitCode, signalCode, killed state, and so on.

When this object is first created and provided, the child process backing the object may still be alive (in many cases, such as long-running server processes, this is intended behavior).

If the backing process is still alive, terminal information will not be available, and signalCode, exitCode, and related properties return null.

When the process exits, or is terminated through a signal, these fields are filled in by the runtime and become visible to the caller.

Types

Companion

object Companion

Properties

channel

open override val channel: ProcessChannel?

Channel used to communicate with the underlying process.

connected

open override val connected: Boolean

Whether the subprocess is active and connected.

exitCode

open override val exitCode: Int?

Exit code for the process, or null if the subprocess terminated due to a signal.

killed

open override val killed: Boolean

Whether the process terminated by being killed.

pid

open override val pid: Long

Process ID for the child process.

signalCode

open override val signalCode: String?

Terminal signal code for the process, or null if the subprocess terminated normally.

stderr

open override val stderr: ProcessOutputStream?

Standard error stream for the child process.

stdin

open override val stdin: ProcessInputStream?

Standard input stream for the child process.

stdio

open override val stdio: ProcessIOChannels

Standard error output stream for the child process.

stdout

open override val stdout: ProcessOutputStream?

Standard output stream for the child process.

Functions

addEventListener

abstract fun addEventListener(type: String, listener: EventListener)

abstract fun addEventListener(type: String, options: AddEventListenerOptions, listener: EventListener)

abstract fun addEventListener(type: String, listener: Value, options: Value?)

Adds a new handler for the type event. Any given listener is added only once per type and per capture option value.

addListener

abstract fun addListener(eventName: String, listener: EventListener)

abstract fun addListener(eventName: String, listener: Value)

Alias for emitter.on(eventName, listener).

abstract override fun close()

disconnect

open override fun disconnect()

Disconnects the child process from the parent.

dispatchEvent

abstract fun dispatchEvent(event: Event): Boolean

Dispatches the event to the list of handlers for Event.type.

emit

abstract fun emit(eventName: String, vararg args: Any?): Boolean

Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

eventNames

abstract fun eventNames(): List<String>

Returns an array listing the events for which the emitter has registered listeners. The values in the array are strings or Symbols.

getMaxListeners

abstract fun getMaxListeners(): Int

Returns the current max listener value for the emitter.

getMember

open override fun getMember(key: String?): Any?

getMemberKeys

open override fun getMemberKeys(): Array<String>

hasMember

open override fun hasMember(key: String): Boolean

kill

open override fun kill(signal: String?)

Kills the child process, using the provided signal.

listenerCount

abstract fun listenerCount(eventName: String): Int

Returns the number of listeners listening to the event named eventName.

listeners

abstract fun listeners(eventName: String): List<EventListener>

Returns an array listing the listeners for the specified event.

off

abstract fun off(eventName: String, listener: Value)

Alias for emitter.removeListener(eventName, listener).

abstract fun on(eventName: String, listener: EventListener): EventEmitter

abstract fun on(eventName: String, listener: Value): EventEmitter

Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added.

once

abstract fun once(eventName: String, listener: EventListener)

abstract fun once(eventName: String, listener: Value)

Adds a one-time listener function for the event named eventName. The next time eventName is triggered, this listener is removed and then invoked.

prependListener

abstract fun prependListener(eventName: String, listener: EventListener)

abstract fun prependListener(eventName: String, listener: Value)

Adds the listener function to the beginning of the listeners array for the event named eventName. No checks are made to see if the listener has already been added.

prependOnceListener

abstract fun prependOnceListener(eventName: String, listener: EventListener)

abstract fun prependOnceListener(eventName: String, listener: Value)

Adds a one-time listener function for the event named eventName to the beginning of the listener array. The next time eventName is triggered, this listener is removed, and then invoked.

putMember