InteractiveProcess
Inherits: Resource
Class for starting an interacting with a process through a psuedo terminal
Description
Starts an interactive session
Properties
| Type | Name | Default |
|---|---|---|
| Pty | pty | |
| String | cmd | |
| PackedStringArray | args | [] |
| int | pid | |
| Platform | platform | |
| ResourceRegistry | registry | |
| Mutex | lines_mutex | |
| PackedStringArray | lines_buffer | PackedStringArray() |
| CustomLogger | logger |
Methods
| Returns | Signature |
|---|---|
| int | start() |
| void | send(input: String) |
| String | read(_chunk_size: int = 1024) |
| void | stop() |
| bool | is_running() |
| int | output_to_log_file(log_file: FileAccess, _chunk_size: int = 1024) |
Property Descriptions
pty
Pty pty
Note
There is currently no description for this property. Please help us by contributing one!
cmd
String cmd
Note
There is currently no description for this property. Please help us by contributing one!
args
PackedStringArray args = []
Note
There is currently no description for this property. Please help us by contributing one!
pid
int pid
Note
There is currently no description for this property. Please help us by contributing one!
platform
Platform platform
Note
There is currently no description for this property. Please help us by contributing one!
registry
ResourceRegistry registry
Note
There is currently no description for this property. Please help us by contributing one!
lines_mutex
Mutex lines_mutex
Note
There is currently no description for this property. Please help us by contributing one!
lines_buffer
PackedStringArray lines_buffer = PackedStringArray()
Note
There is currently no description for this property. Please help us by contributing one!
logger
CustomLogger logger
Note
There is currently no description for this property. Please help us by contributing one!
Method Descriptions
start()
int start()
Start the interactive process
send()
void send(input: String)
Send the given input to the running process
read()
String read(_chunk_size: int = 1024)
Read from the stdout of the running process
stop()
void stop()
Stop the given process
is_running()
bool is_running()
Returns whether or not the interactive process is still running
output_to_log_file()
int output_to_log_file(log_file: FileAccess, _chunk_size: int = 1024)
Note
There is currently no description for this method. Please help us by contributing one!