Process

This object allows you to start and manage a process. (program)

Constructor function.

var myObject = new Process();

var myObject = new Process(parameters);

1. parameters - (object) the parameters
   • workingDirectory - (string) the working directory
   • processChannelMode - (ProcessChannelMode) the process's channel mode
   • readChannel - (ProcessChannel) the process's read channel
   • onError - (onError) called when an error has occured
   • onFinished - (onFinished) called when the process has finished
   • onReadyReadStandardError - (onReadyReadStandardError) called when the process has data on the standard error channel
   • onReadyReadStandardOutput - (onReadyReadStandardOutput) called when the process has data on the standard output channel
   • onStarted - (onStarted) called when the process has started
   • onStateChanged - (onStateChanged) called when the process's state has changed

var myObject = new Process();

var myObject = new Process({
	workingDirectory: "/home/user",
	onStarted: function()
	{
		Console.print("Started!");
	},
	onFinished: function()
	{
		Console.print("Finished!");
	}
});

Returns an array of ProcessHandle linked to all running processes.

Process.list();

• (array) an array of ProcessHandle linked to all running processes

Returns a ProcessHandle linked to the Actionaz process.

Process.thisProcess();

• (array) a ProcessHandle linked to the Actionaz process

Starts a process in detached mode and returns a ProcessHandle linked to it. You will have lesser control on the process than in attached mode, but it will be independent of the current execution.

Process.startDetached(filename);

Process.startDetached(filename, parameters);

Process.startDetached(filename, parameters, workingDirectory);

1. filename - (string) the filename/command of the process to start
2. parameters - (array) an array of parameters
3. workingDirectory - (string) the working directory

• (array) a ProcessHandle linked to the started process

• (FilenameError) invalid filename
• (StartProcessError) unable to start the process

Returns a ProcessHandle linked to the started process

myObject.handle();

• (ProcessHandle) a ProcessHandle linked to the started process

Returns the process id of the started process.

myObject.id();

• (integer) the process id of the started process

Starts the process.

myObject.start(filename);

myObject.start(filename, parameters);

myObject.start(filename, parameters, openMode);

1. filename - (string) the filename/command of the process to start
2. parameters - (array) an array of parameters
3. openMode - (OpenMode) the open mode to use (default: read and write)

• (Process) this Process

• (FilenameError) invalid filename

Returns the state of the started process.

myObject.state();

• (ProcessState) the state of the started process

Returns the error state of the started process.

myObject.error();

• (ProcessError) the error state of the started process

Returns the process's exit code.

myObject.exitCode();

• (integer) the process's exit code

Returns the process's exit status.

myObject.exitStatus();

• (ExitStatus) the process's exit status

Returns the content of the standard error output as a RawData.

myObject.readError();

• (RawData) the content of the standard error output as a RawData

Returns the content of the standard output as a RawData.

myObject.read();

• (RawData) the content of the standard output as a RawData

Returns the content of the standard error output as text.

myObject.readErrorText();

myObject.readErrorText(encoding);

1. encoding - (Encoding) the encoding to use

• (string) the content of the standard error output as text

Returns the content of the standard output as text.

myObject.readText();

myObject.readText(encoding);

1. encoding - (Encoding) the encoding to use

• (string) the content of the standard output as text

Returns true if the process is not running and if no data can be read.

myObject.atEnd();

• (boolean) true if the process is not running and if no data can be read

Returns the number of bytes that can be read.

myObject.bytesAvailable();

• (integer) the number of bytes that can be read

Returns the number of bytes that are still to be written.

myObject.bytesToWrite();

• (integer) the number of bytes that are still to be written

Returns true if a line can be read.

myObject.canReadLine();

• (boolean) true if a line can be read

Writes some data to the process.

myObject.write(data);

1. data - (mixed) the data to write

• (Process) this Process

Writes text to the process.

myObject.writeText(text, encoding);

1. text - (string) the text to write
2. encoding - (Encoding) the encoding to use

• (Process) this Process

Sets the working directory. This only works when the process is not already started.

myObject.setWorkingDirectory(workingDirectory);

1. workingDirectory - (string) the text to write

• (Process) this Process

Sets process's channel mode. This only works when the process is not already started.

myObject.setProcessChannelMode(channelMode);

1. channelMode - (ProcessChannelMode) the process's channel mode

• (Process) this Process

Sets the process's environment variables. This only works when the process is not already started.

myObject.setEnvironment(environment);

1. environment - (object) the process's environment variable

• (Process) this Process

myObject.setEnvironment({
	PATH: "c:\\;c:\\path",
	MYVAR: "hello"
});

Updates the process's environment variables. This only works when the process is not already started.

myObject.updateEnvironment(environment);

1. environment - (object) the process's environment variable

• (Process) this Process

myObject.updateEnvironment({
	PATH: "c:\\;c:\\path",
	MYVAR: "hello"
});

Sets process's read channel.

myObject.setReadChannel(channel);

1. channel - (ProcessChannel) the process's read channel

• (Process) this Process

Sets the standard error file.

myObject.setStandardErrorFile(fileName);

myObject.setStandardErrorFile(fileName, openMode);

1. fileName - (string) the filename
2. channel - (OpenMode) the file's open mode (default: Truncate)

• (Process) this Process

Sets the standard input file.

myObject.setStandardInputFile(fileName);

1. fileName - (string) the filename

• (Process) this Process

Sets the standard output file.

myObject.setStandardOutputFile(fileName);

myObject.setStandardOutputFile(fileName, openMode);

1. fileName - (string) the filename
2. channel - (OpenMode) the file's open mode (default: Truncate)

• (Process) this Process

Sets the standard output process.

myObject.setStandardOutputFile(process);

1. process - (Process) the output process

• (Process) this Process

• (InvalidProcessError) invalid process

Freezes the execution until the process has finished.

myObject.waitForFinished(waitTime);

myObject.waitForFinished();

1. waitTime - (integer) the time to wait (milliseconds, default: 30000)

• (Process) this Process

• (WaitForFinishedError) wait for finished failed

Freezes the execution until the process has started.

myObject.waitForStarted(waitTime);

myObject.waitForStarted();

1. waitTime - (integer) the time to wait (milliseconds, default: 30000)

• (Process) this Process

• (WaitForStartedError) wait for started failed

Freezes the execution until the data has been written.

myObject.waitForBytesWritten(waitTime);

myObject.waitForBytesWritten();

1. waitTime - (integer) the time to wait (milliseconds, default: 30000)

• (Process) this Process

• (WaitForBytesWrittenError) wait for bytes written failed

Freezes the execution until data is available.

myObject.waitForReadyRead(waitTime);

myObject.waitForReadyRead();

1. waitTime - (integer) the time to wait (milliseconds, default: 30000)

• (Process) this Process

• (WaitForReadyReadError) wait for ready read failed

Tries to close the process gracefully.

myObject.close();

• (Process) this Process

Kills the process.

myObject.kill();

• (Process) this Process

Terminates the process.

myObject.terminate();

• (Process) this Process

Called when an error occured.

myObject.onError = function(processError) {};

1. processError - (ProcessError) the process error that has occured

myObject.onError = function(processError)
{
	//Event action
};

Called when the process has finished.

myObject.onFinished = function(exitCode, exitStatus) {};

1. exitCode - (integer) the process's exit code
2. exitStatus - (ExitStatus) the process's exit status

myObject.onFinished = function(exitCode, exitStatus)
{
	//Event action
};

Called when there is data available on the standard error output.

myObject.onReadyReadStandardError = function() {};

myObject.onReadyReadStandardError = function()
{
	//Event action
};

Called when there is data available on the standard output.

myObject.onReadyReadStandardOutput = function() {};

myObject.onReadyReadStandardOutput = function()
{
	//Event action
};

Called when the process has started executing.

myObject.onStarted = function() {};

myObject.onStarted = function()
{
	//Event action
};

Called when the process's state has changed.

myObject.onStateChanged = function(newState) {};

1. newState - (ProcessState) the process's state

myObject.onStateChanged = function(newState)
{
	//Event action
};

A process error.

1. FailedToStart: the file cannot be found or insufficient permissions
2. Crashed: the process has crashed after having started successfully
3. Timedout: the last waitFor… method failed
4. WriteError: the process is not running or it may have closed it's input channel
5. ReadError: the process is not running
6. UnknownError: an unknown error has occured

The process's exit status.

1. NormalExit: the process finished normally
2. CrashExit: the process crashed

The process's status.

1. NotRunning: the process is not running
2. Starting: the process is starting
3. Running: the process is running

A process's channel.

1. StandardOutput: the standard output channel
2. StandardError: the standard error output channel

A process's channel mode.

1. SeparateChannels: the standard error and output channels are separated
2. MergedChannels: the standard error channel is redirected to the the standard output channel
3. ForwardedChannels: the output of both channels is redirected to the parent process

A process's channel open mode.

1. ReadOnly: process channel opened for reading only
2. WriteOnly: process channel opened for writing only
3. ReadWrite: process channel opened for reading and writing
4. Truncate: process channel opened for writing, erases any previous content
5. Text: process channel opened in text mode
6. Unbuffered: process channel opened in unbuffered mode