SessionOpen class final
Client → Hub: opens a session on a node over a new client channel.
- Inheritance
-
- Object
- ControlMessage
- SessionOpen
Constructors
-
SessionOpen({required int channel, required String nodeId, required SessionMode mode, String? command, List<
String> args = const [], Map<String, String> env = const {}, String? cwd, PtySpec? pty, String? resumeSessionId, ShellFamily? shellFamily}) -
Creates a session-open.
const
Properties
-
args
→ List<
String> -
Command arguments.
final
- channel → int
-
The client-allocated channel id.
final
- channelId → int?
-
The channel this message pertains to, or
nullfor connection-level messages (the envelopecfield).no setteroverride - command → String?
-
The command to run (exec) or shell to launch (shell); may be
null.final - cwd → String?
-
Working directory;
nullfor the node default.final -
env
→ Map<
String, String> -
Extra environment variables.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- mode → SessionMode
-
Exec or interactive shell.
final
- nodeId → String
-
The target node.
final
- pty → PtySpec?
-
Requested terminal geometry for interactive shells.
final
- resumeSessionId → String?
-
When set, resume the existing detached session identified by this id (or
unambiguous prefix) instead of starting a new shell. The node enforces
that the resuming principal owns the session.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- shellFamily → ShellFamily?
-
For exec mode: run the command under this shell family's interpreter on
the node (see ShellRequest.shellFamily);
nulluses the node default.final - type → String
-
The stable type discriminator (the envelope
tfield).no setteroverride
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
The message payload (the envelope
dfield), without the type or channel.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
fromJson(
int? channel, Map< String, dynamic> d) → SessionOpen - Decodes a SessionOpen.