NodeSessionOpen class final
Hub → Node: instructs the node to start a session on a node-side channel.
- Inheritance
-
- Object
- ControlMessage
- NodeSessionOpen
Constructors
-
NodeSessionOpen({required int channel, required String sessionId, required String principal, required SessionMode mode, String? command, List<
String> args = const [], Map<String, String> env = const {}, String? cwd, PtySpec? pty, String? resumeSessionId, ShellFamily? shellFamily}) -
Creates a node-session-open.
const
Properties
-
args
→ List<
String> -
Command arguments.
final
- channel → int
-
The hub-allocated node-side channel id.
final
- channelId → int?
-
The channel this message pertains to, or
nullfor connection-level messages (the envelopecfield).no setteroverride - command → String?
-
The command or shell.
final
- cwd → String?
-
Working directory.
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
- principal → String
-
The authenticated principal opening the session.
final
- pty → PtySpec?
-
Requested terminal geometry.
final
- resumeSessionId → String?
-
When set, the node resumes the existing detached session with this id (or
unambiguous prefix), owned by principal, instead of starting a shell.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- sessionId → String
-
The minted session id.
final
- 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) → NodeSessionOpen - Decodes a NodeSessionOpen.