TerminalPtyLibraryBase class abstract
PtyLibrary represents a process running in a pseudo-terminal.
To create a PtyLibrary, use PtyLibrary.start
.
- Implementers
Constructors
-
TerminalPtyLibraryBase.new({String executable = "sh", String? workingDirectory, String? libraryPtyPath, List<
String> ? arguments, Map? environment, int rows = 25, int columns = 80, bool isAckRead = false}) -
Spawns a process in a pseudo-terminal. The arguments have the same meaning
as in Process.start.
ackRead indicates if the pty should wait for a call to
PtyLibrary.ackRead
before sending the next data.
Properties
-
arguments
↔ List<
String> -
latefinal
- columns → int
-
final
- environment → Map?
-
final
- event_emitter → EventEmitter
-
final
- event_input → String
-
final
- event_output → String
-
final
- executable → String
-
final
-
exitCode
→ Future<
int> -
A
Future
which completes with the exit code of the process when the process completes.no setter - hashCode → int
-
The hash code for this object.
no setterinherited
- isAckRead → bool
-
final
- isInitialized ↔ bool
-
getter/setter pair
- libraryPtyPath ↔ String
-
latefinal
- pid → int
-
The process id of the process running in the pseudo-terminal.
no setter
- rows → int
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- workingDirectory → String?
-
final
Methods
-
ackRead(
) → void - indicates that a data chunk has been processed. This is needed when ackRead is set to true as the pty will wait for this signal to happen before any additional data is sent.
-
ensureInitialized(
) → void -
kill(
[ProcessSignal signal = ProcessSignal.sigterm]) → bool - Kill the process running in the pseudo-terminal.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
on(
{required String eventName, required FutureOr onCallback(dynamic update, TerminalPtyLibraryBase terminalPtyLibraryBase)}) → EventEmitterListener -
resize(
int rows, int cols) → void - Resize the pseudo-terminal.
-
toString(
) → String -
A string representation of this object.
inherited
-
write(
Uint8List data) → void - Write data to the pseudo-terminal.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
- defaultLibraryPtyPath → String
-
no setter
- defaultShell → String
-
no setter
- is_dynamic_library_pty_initialized ↔ bool
-
getter/setter pair
- pty_library_init ↔ int
-
latefinal