ketraterm-session/io.github.ketraterm.session/TerminalSession

TerminalSession

class TerminalSession(val terminal: TerminalBuffer, val publisher: TerminalRenderPublisher, renderReader: TerminalRenderFrameReader, responseReader: TerminalHostResponseReader, connector: TerminalConnector, parser: TerminalOutputParser, inputEncoder: TerminalInputEncoder, hyperlinkResolver: TerminalHyperlinkResolver = TerminalHyperlinkResolver.NONE, outboundWriteLock: Any = Any(), val shellIntegrationState: TerminalShellIntegrationState = TerminalShellIntegrationState(), hostCommandAdapter: HostCommandAdapter? = null, inputPolicy: TerminalInputPolicy = TerminalInputPolicy()) : TerminalConnectorListener, TerminalInputEncoder, TerminalRenderFrameReader, AutoCloseable

Runtime terminal session that binds core, parser, input encoding, and a transport connector.

The connector owns transport threads. This session owns parser/core mutation serialization and all host-bound write ordering.

Constructors

TerminalSession

constructor(terminal: TerminalBuffer, publisher: TerminalRenderPublisher, renderReader: TerminalRenderFrameReader, responseReader: TerminalHostResponseReader, connector: TerminalConnector, parser: TerminalOutputParser, inputEncoder: TerminalInputEncoder, hyperlinkResolver: TerminalHyperlinkResolver = TerminalHyperlinkResolver.NONE, outboundWriteLock: Any = Any(), shellIntegrationState: TerminalShellIntegrationState = TerminalShellIntegrationState(), hostCommandAdapter: HostCommandAdapter? = null, inputPolicy: TerminalInputPolicy = TerminalInputPolicy())

Types

Companion

object Companion

Properties

exitCode

@Volatile

var exitCode: Int?

Remote process exit code after onClosed receives one.

failure

@Volatile

var failure: Throwable?

Transport failure reported by onError, or null when the remote closed normally or the session was locally closed.

isClosed

val isClosed: Boolean

Returns true after either local shutdown, remote closure, or transport failure has made the session unable to accept more input.

onDirty

var onDirty: () -> Unit?

Optional callback invoked after a render frame is published.

publisher

val publisher: TerminalRenderPublisher

the render publisher responsible for frames updates.

shellIntegrationState

val shellIntegrationState: TerminalShellIntegrationState

shared host-side prompt and command marker state.

terminal

val terminal: TerminalBuffer

public terminal buffer mutated by host output.

Functions

addCloseListener

fun addCloseListener(listener: TerminalSessionCloseListener)

Registers a listener that is invoked exactly once when this session reaches a terminal lifecycle state.

addDirtyListener

fun addDirtyListener(listener: () -> Unit)

Registers a listener to be notified when the session needs a render repaint.

open override fun close()

Requests local connector shutdown and closes parser input exactly once.

currentWorkingDirectoryUri

fun currentWorkingDirectoryUri(): String?

Returns the latest valid OSC 7 current-working-directory URI.

encodeFocus

open override fun encodeFocus(event: TerminalFocusEvent)

Encodes a focus event and writes it to the connector unless closed.

encodeKey

open override fun encodeKey(event: TerminalKeyEvent)

encodeMouse

open override fun encodeMouse(event: TerminalMouseEvent)

Encodes a mouse event and writes it to the connector unless closed.

encodePaste

open override fun encodePaste(event: TerminalPasteEvent)

Encodes a paste event and writes it to the connector unless closed.

hyperlinkUri

fun hyperlinkUri(hyperlinkId: Int): String?

Resolves a primitive render-frame hyperlink id to a target URI.

notifyRenderDirty

fun notifyRenderDirty()

Submits a render task to the worker thread.

onBytes

open override fun onBytes(bytes: ByteArray, offset: Int, length: Int)

Consumes host bytes synchronously, mutating parser/core before returning.

onClosed

open override fun onClosed(exitCode: Int?)

Records remote closure and closes the parser exactly once.

onError

open override fun onError(error: Throwable)

Records transport failure and treats it as remote closure without a process exit code.

readRenderFrame

open override fun readRenderFrame(consumer: TerminalRenderFrameConsumer)

Reads a short-lived render frame while holding the terminal mutation lock.

open override fun readRenderFrame(scrollbackOffset: Int, consumer: TerminalRenderFrameConsumer)

Reads a render frame with a specified scrollback offset.

open override fun readRenderFrame(scrollbackOffset: Int, viewportRows: Int, consumer: TerminalRenderFrameConsumer)

Reads a render frame with a specified scrollback offset and viewport rows limit.

removeCloseListener

fun removeCloseListener(listener: TerminalSessionCloseListener)

Unregisters a previously registered session close listener.

removeDirtyListener

fun removeDirtyListener(listener: () -> Unit)

Unregisters a previously registered render repaint listener.

requestRender

fun requestRender(scrollbackOffset: Int)

Requests a render-cache publication for a caller-owned scrollback viewport.

fun requestRender(scrollbackOffset: Int, viewportRows: Int)

Requests a render-cache publication with optional render-only viewport overscan rows.

resize

fun resize(columns: Int, rows: Int, oldScrollbackOffset: Int = 0): Pair<Int, Int>

Resizes core, publisher, and the active connector.

setCursorShape

fun setCursorShape(shape: TerminalRenderCursorShape)

Updates the current and default cursor shape for the session.

setHostPolicy

fun setHostPolicy(policy: HostPolicy)

Updates the active host security policy dynamically.

setInputPolicy

open override fun setInputPolicy(policy: TerminalInputPolicy)

Updates the active terminal input policy dynamically.

setPasteSanitizationPolicy

fun setPasteSanitizationPolicy(policy: PasteSanitizationPolicy)

Updates only the active paste sanitization policy.

setThemePalette

fun setThemePalette(palette: TerminalColorPalette)

Sets the theme-configured color palette for the session.

setTreatAmbiguousAsWide

fun setTreatAmbiguousAsWide(enabled: Boolean)

Applies the host's East Asian Ambiguous width policy for future writes.

start

fun start(columns: Int, rows: Int)

Starts the connector after resizing core and transport to columns x rows.