ketraterm-core/io.github.ketraterm.core.api/TerminalResponseChannel

TerminalResponseChannel

interface TerminalResponseChannel : TerminalHostResponseReader

Terminal-to-host response channel.

Host applications should drain these bytes and write them to the PTY/process input side. Parser/host code should use the request methods; core owns response contents that depend on core state such as cursor position.

Inheritors

TerminalBuffer

Types

Companion

object Companion

Properties

pendingResponseBytes

abstract val pendingResponseBytes: Int

The number of queued response bytes currently waiting to be read.

Functions

clearResponseBytes

abstract fun clearResponseBytes()

Discards all queued response bytes from this channel.

queryDynamicColor

abstract fun queryDynamicColor(target: Int)

Enqueues the color query response for a dynamic target (10, 11, or 12).

queryPaletteColor

abstract fun queryPaletteColor(index: Int)

Enqueues the color query response for a specific 256-color palette index.

queryStatusString

abstract fun queryStatusString(query: String)

Enqueues the response for a DCS DECRQSS request.

queryTerminfo

abstract fun queryTerminfo(rawPayload: String)

Enqueues the response for a DCS XTGETTCAP request.

readResponseBytes

abstract fun readResponseBytes(dst: ByteArray, offset: Int = 0, length: Int = dst.size - offset): Int

Reads up to length queued response bytes into dst.

requestDeviceAttributes

abstract fun requestDeviceAttributes(kind: Int, parameter: Int)

Enqueues a device attributes (DA) report response.

requestDeviceStatusReport

abstract fun requestDeviceStatusReport(mode: Int, decPrivate: Boolean)

Enqueues a device status report (DSR) response.

requestKeyModifierOption

abstract fun requestKeyModifierOption(resource: Int)

Enqueues an allowlisted xterm key-modifier option response.

requestKittyKeyboardFlags

abstract fun requestKittyKeyboardFlags()

Enqueues the active Kitty keyboard progressive-enhancement flags as a parameterless CSI ? u query response. Core reports only flags retained by its supported-mode mask.

requestRectangleChecksum

abstract fun requestRectangleChecksum(requestId: Int, page: Int, top: Int, left: Int, bottom: Int, right: Int)

Enqueues a VT420 DECRQCRA response for an active-page rectangular area.

requestWindowReport

abstract fun requestWindowReport(mode: Int)

Enqueues a window report response.

setWindowMinimized

abstract fun setWindowMinimized(minimized: Boolean)

Updates the recorded window minimization state.

setWindowSizePixels

abstract fun setWindowSizePixels(width: Int, height: Int)

Updates the recorded window size in pixels.