Foundry.RunTool¶

Subclasses:: None

Methods¶

Inherited:: Foundry.Contextual (4), GObject.Object (37), Json.Serializable (8)
Structs:: GObject.ObjectClass (5)

	`await_` ()
	`dup_plugin_info` ()
	`force_exit` ()
	`send_signal` (signum)

Virtual Methods¶

Inherited:: GObject.Object (7), Json.Serializable (5)

	`do_force_exit` ()
	`do_send_signal` (signum)
	`do_started` (subprocess)
	`do_stopped` ()

Properties¶

Inherited:: Foundry.Contextual (1)

Name	Type	Flags	Short Description
`plugin-info`	`Peas.PluginInfo`	r/w/co

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`started`
`stopped`

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`Foundry.Contextual`	r

Class Details¶

class Foundry.RunTool(**kwargs)¶

Bases:: Foundry.Contextual
Abstract:: Yes
Structure:: Foundry.RunToolClass

Represents a specific tool that can be used to run the application.

This allows implementing specialized tooling like debuggers, profilers, machine emulators, and more.

await_()¶

Returns:: a [class`Dex`.Future] that resolves when the process has completed.
Return type:: Dex.Future

dup_plugin_info()¶

Returns:: a [class`Peas`.PluginInfo]
Return type:: Peas.PluginInfo or None

force_exit()¶

Returns:: a [class`Dex`.Future] that resolves when the request to force exit has been sent.
Return type:: Dex.Future

Requests the application exit.

The future resolves when the signal has been sent or equivalent operation. That does not mean the process has stopped and depends on where the tool is running (such as a remote device).

send_signal(signum)¶

Parameters:: signum (int) –
Returns:: a [class`Dex`.Future] that resolves when the signal has been sent.
Return type:: Dex.Future

Sends a signal to the running application.

The future resolves when the signal has been sent. There is no guarantee of signal delivery.

do_force_exit() virtual¶

Returns:: a [class`Dex`.Future] that resolves when the request to force exit has been sent.
Return type:: Dex.Future

Requests the application exit.

The future resolves when the signal has been sent or equivalent operation. That does not mean the process has stopped and depends on where the tool is running (such as a remote device).

do_send_signal(signum) virtual¶

Parameters:: signum (int) –
Returns:: a [class`Dex`.Future] that resolves when the signal has been sent.
Return type:: Dex.Future

Sends a signal to the running application.

The future resolves when the signal has been sent. There is no guarantee of signal delivery.

do_started(subprocess) virtual¶

Parameters:: subprocess (Gio.Subprocess) –

do_stopped() virtual¶

Signal Details¶

Foundry.RunTool.signals.started(run_tool, object)¶

Signal Name:

started

Flags:

RUN_LAST

Parameters:

run_tool (Foundry.RunTool) – The object which received the signal
object (Gio.Subprocess) –

Foundry.RunTool.signals.stopped(run_tool)¶

Signal Name:: stopped
Flags:: RUN_LAST
Parameters:: run_tool (Foundry.RunTool) – The object which received the signal

Property Details¶

Foundry.RunTool.props.plugin_info¶

Name:: plugin-info
Type:: Peas.PluginInfo
Default Value:: None
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY