Core

Process

Process helper.

9 public methods

Import

from Xenonix.Core import Process

Search this API

Filter methods, arguments, and configuration keys on this page.

Configuration

Use Config(...) with these keys where the class exposes configuration.

This object does not expose a public Config table.

Public methods

Create

Creates a new Process instance.

Create(Name, Script_Path, Args=None, Cwd=None, Env=None, Inherit_Output=False, Merge_Stderr=False, Kill_With_Parent=True)

Arguments

Argument	Default	Accepted values	What it does
`Name`	Required	Any valid value	Display/name identifier.
`Script_Path`	Required	Any valid value	Script Path value used by the operation.
`Args`	`None`	Any valid value	Args value used by the operation.
`Cwd`	`None`	Any valid value	Cwd value used by the operation.
`Env`	`None`	Any valid value	Env value used by the operation.
`Inherit_Output`	`False`	Any valid value	Turns inherit output on or off.
`Merge_Stderr`	`False`	Any valid value	Turns merge stderr on or off.
`Kill_With_Parent`	`True`	Any valid value	Turns kill with parent on or off.

Output

Creates a new Process object.

Start

Starts the process or connection.

Start()

Arguments

No arguments.

Output

Returns success/status or the operation result.

Stop

Stops the process or connection.

Stop(Grace_Sec=5.0)

Arguments

Argument	Default	Accepted values	What it does
`Grace_Sec`	`5.0`	Any valid value	Grace Sec value used by the operation.

Output

Returns success/status or the operation result.

Restart

Runs the Restart operation for Process.

Restart(Grace_Sec=5.0)

Arguments

Argument	Default	Accepted values	What it does
`Grace_Sec`	`5.0`	Any valid value	Grace Sec value used by the operation.

Output

Returns the calculated result.

Status

Runs the Status operation for Process.

Status()

Arguments

No arguments.

Output

Returns True/False to indicate success.

Wait

Runs the Wait operation for Process.

Wait(Timeout_Sec=None)

Arguments

Argument	Default	Accepted values	What it does
`Timeout_Sec`	`None`	Any valid value	Timeout Sec value used by the operation.

Output

Returns the calculated result.

Uptime

Runs the Uptime operation for Process.

Uptime()

Arguments

No arguments.

Output

Returns the calculated result.

Check

Runs the Check operation for Process.

Check()

Arguments

No arguments.

Output

Returns the calculated result.

Send_Signal

Runs the Send_Signal operation for Process.

Send_Signal(Sig)

Arguments

Argument	Default	Accepted values	What it does
`Sig`	Required	Any valid value	Sig value used by the operation.

Output

Returns True/False to indicate success.