InitFrame class final

The handshake. The peer sends one before any InputFrame, carrying the remote display's size and the capabilities the app should plan against (color mode, image protocol, multiplexer wrapping), and the protocol it speaks. The app answers with one of its own (see protocolVersion and terminalInput).

Inheritance

Constructors

InitFrame({required CellSize size, required ColorMode colorMode, GlyphTier glyphTier = GlyphTier.unicode, required ImageProtocol imageProtocol, required bool tmuxPassthrough, InlineImageSupport? images, bool hyperlinks = false, KeyboardCapabilities? keyboard, RemoteWireProtocol protocol = RemoteWireProtocol.structured, int? protocolVersion, TerminalInputModes? terminalInput, bool provisional = false, bool? debugWire})
const

Properties

colorMode → ColorMode
final
debugWire → bool?
The supervisor's decision on the debug wire (fleury serve --debug), carried on a provisional INIT. Null on a peer's INIT: the app then keeps its environment rule (FLEURY_DEBUG_WIRE).
final
glyphTier → GlyphTier
final
hashCode → int
The hash code for this object.
no setterinherited
Whether the peer's surface can render real hyperlinks (OSC 8 on a terminal, <a> anchors in the browser). Optional hyperlinks=1 INIT param, false when absent. Threaded into the app-side SurfaceCapabilities.hyperlinks so the server-side producer gate (e.g. MarkdownText) only emits a linkUri when the peer can actually show it.
final
imageProtocol → ImageProtocol
The terminal-projection fields: a shell peer (fleury shell, a real terminal) genuinely has an escape protocol and a multiplexer.
final
images → InlineImageSupport?
The peer's neutral image capability (images= param). Null from the ANSI host (fleury shell), whose image support the app projects from imageProtocol instead.
final
keyboard → KeyboardCapabilities?
What the peer's keyboard has been CONFIRMED to guarantee (RFC 0020 §11). Optional keyboard=<bits> INIT param.
final
protocol → RemoteWireProtocol
Which of the wire's two protocols the sender speaks: v=<n> on the wire for RemoteWireProtocol.structured, shell=<n> for RemoteWireProtocol.shell.
final
protocolVersion → int
The version of protocol the sender speaks; by default this build's (RemoteWireProtocol.version).
no setter
provisional → bool
A supervisor's greeting, not a handshake.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
size → CellSize
final
terminalInput → TerminalInputModes?
The terminal input the app reads — its TerminalMode's input half, with the environment's keyboard override applied — which the peer's terminal must report for it: mouse clicks and drags, pointer motion, bracketed pastes, focus changes, and keys at a Kitty keyboard tier.
final
tmuxPassthrough → bool
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited