KetraTermcreate
Assembles a production session from a buffer exposing core and render roles.
Uses the same services and customization factories as the separate-reader overload. Ownership transfers only after successful construction. Custom factories must not perform I/O or start jobs during construction.
Return
the assembled session, which owns the supplied runtime collaborators.
Parameters
exclusively owned core buffer and matching render projection.
exclusively owned transport.
accepted metadata/request receiver.
initial host authorization and bounds.
initial input-encoding policy.
flags the host can implement truthfully.
non-owned render, metadata and timeout dispatcher.
command deferred until shell prompt readiness, or null.
non-owned dispatcher for connector writes and providers.
implemented host-action mask.
session-bound clipboard provider, or null.
monotonic clipboard deadline source.
sole metadata producer, or null.
creates independent admission and bulk encoders.
custom parser factory; preserve TerminalGraphicsOutputParser for session decoding.
Throws
for invalid dimensions, startup without shell integration, incompatible render state or a factory reusing an encoder instance.
Assembles a production session from a buffer exposing core and render roles.
Uses the same services and customization factories as the separate-reader overload. Ownership transfers only after successful construction. Custom factories must not perform I/O or start jobs during construction.
Return
the assembled session, which owns the supplied runtime collaborators.
Parameters
exclusively owned core buffer and matching render projection.
exclusively owned transport.
accepted metadata/request receiver.
initial host authorization and bounds.
initial input-encoding policy.
flags the host can implement truthfully.
non-owned render, metadata and timeout dispatcher.
command deferred until shell prompt readiness, or null.
non-owned dispatcher for connector writes and providers.
implemented host-action mask.
session-bound clipboard provider, or null.
monotonic clipboard deadline source.
sole metadata producer, or null.
creates independent admission and bulk encoders.
custom parser factory; preserve TerminalGraphicsOutputParser for session decoding.
non-owned off-UI blocking cleanup dispatcher, independent of connector writes.
Throws
for invalid dimensions, startup without shell integration, incompatible render state or a factory reusing an encoder instance.
Assembles core and render collaborators with session-owned host services.
Width must be at least TerminalBuffers.MIN_WIDTH and height must be positive. Dimensions are validated before factory calls or connector ownership transfer. The collaborators must describe the same terminal state; equal dimensions alone cannot establish that relationship. Factory failures leave the connector with its caller and start no session workers.
Return
standard production terminal session.
Parameters
core buffer transferred to the session's exclusive runtime ownership.
render projection of the same core state.
transport connector transferred to the session; closed on every terminal lifecycle path.
metadata events target.
safety policy.
key-encoding policy.
implemented host actions from TerminalHostModeCapability; defaults to none.
progressive Kitty keyboard flags the active input host can provide truthfully. Defaults to the conservative portable-host profile.
non-owned dispatcher used for render publication and timeouts.
optional command submitted once after the selected integration reports prompt readiness. User input before readiness cancels submission.
non-owned dispatcher for connector writes, metadata queries, and clipboard providers.
session-bound clipboard/consent operation, or null for unavailable reads.
monotonic elapsed-time source for clipboard provider and reply-commit deadline checks. Deterministic tests should share its time domain with the worker dispatcher's delay scheduler. This does not change the fixed read timeout or other session timers.
sole shell metadata producer; null leaves shell features unavailable.
creates independent admission and bulk encoders bound to session-owned output.
customizes parsing using the assembled host sink and its live clipboard budget. Pass both to TerminalParsers.create when adding a custom OSC handler. Its callback runs under mutation serialization and may read frames before later output. It must not call mutating session APIs or close the session.
Throws
when terminal dimensions are invalid, the initial render frame is absent or has incompatible dimensions, or the input factory reuses one encoder instance.
Assembles core and render collaborators with session-owned host services.
Width must be at least TerminalBuffers.MIN_WIDTH and height must be positive. Dimensions are validated before factory calls or connector ownership transfer. The collaborators must describe the same terminal state; equal dimensions alone cannot establish that relationship. Factory failures leave the connector with its caller and start no session workers.
Return
standard production terminal session.
Parameters
core buffer transferred to the session's exclusive runtime ownership.
render projection of the same core state.
transport connector transferred to the session; closed on every terminal lifecycle path.
metadata events target.
safety policy.
key-encoding policy.
implemented host actions from TerminalHostModeCapability; defaults to none.
progressive Kitty keyboard flags the active input host can provide truthfully. Defaults to the conservative portable-host profile.
non-owned dispatcher used for render publication and timeouts.
optional command submitted once after the selected integration reports prompt readiness. User input before readiness cancels submission.
non-owned dispatcher for connector writes, metadata queries, and clipboard providers.
session-bound clipboard/consent operation, or null for unavailable reads.
monotonic elapsed-time source for clipboard provider and reply-commit deadline checks. Deterministic tests should share its time domain with the worker dispatcher's delay scheduler. This does not change the fixed read timeout or other session timers.
sole shell metadata producer; null leaves shell features unavailable.
creates independent admission and bulk encoders bound to session-owned output.
non-owned dispatcher for asynchronous shutdown, independent of blocked connector writes. Must execute blocking cleanup off UI threads.
customizes parsing using the assembled host sink and its live clipboard budget. Pass both to TerminalParsers.create when adding a custom OSC handler. Its callback runs under mutation serialization and may read frames before later output. It must not call mutating session APIs or close the session.
Throws
when terminal dimensions are invalid, the initial render frame is absent or has incompatible dimensions, or the input factory reuses one encoder instance.