KetraTerm
API · DevelopmentAll versions

bind

fun bind(session: TerminalSession, onComplete: (Throwable?) -> Unit = mutationFailureHandler)

Binds rendering and input to the host-owned session.

Binding applies the current ambiguous-width policy, palette, cursor shape, and paste policy to the session. Positive component bounds also resize its grid and connector. Scrolling controls the session's single published viewport. Prior session settings are not restored when unbinding.

Rebinding cancels the previous view's observation and pending mutations; it does not close either session. View binding takes effect on the EDT; captured session settings and geometry are applied in order on a worker. Calls from other threads dispatch asynchronously to the EDT.

Parameters

session

terminal session to display.

onComplete

receives null after initial session settings and geometry have applied, or their failure. Runs once on the EDT; rebinding or disposal before admission reports CancellationException.

Throws

if the bounded session mutation queue is full.