ConnectBot Telnet Library/org.connectbot.telnetlib/TelnetEngine

TelnetEngine

class TelnetEngine(source)

Deterministic, single-owner client engine. No sockets, callbacks, or coroutine state. Feed at most CHUNK_SIZE bytes per step; repeat with the unconsumed suffix. A result consumes input or reports a terminal failure; empty input is a no-op. Call start once before other operations and finish once at peer EOF. Invalid slices, dimensions and oversized writes throw IllegalArgumentException. Starting twice or using an unstarted engine throws IllegalStateException.

Types

object Companion

Properties

val config: TelnetConfig

val snapshot: TelnetSnapshot

Functions

fun carriageReturn(): TelnetResult

fun feed(buffer: ByteBuffer): TelnetResult

Advances position by consumed bytes; never changes limit or retains the buffer.

fun feed(bytes: ByteArray, offset: Int = 0, length: Int = bytes.size - offset): TelnetResult

fun finish(): TelnetResult

Completes valid data and diagnoses a truncated control without dispatching partial SB.

fun flush(): TelnetResult

fun isEnabled(option: TelnetOption, direction: TelnetDirection): Boolean

fun requestOption(option: TelnetOption, direction: TelnetDirection, enable: Boolean): TelnetResult

fun resize(columns: Int, rows: Int): TelnetResult

fun sendCommand(command: TelnetCommand): TelnetResult

fun start(): TelnetResult

fun timeoutCharset(): TelnetResult

fun write(bytes: ByteArray, offset: Int = 0, length: Int = bytes.size - offset): TelnetResult

Encodes one bounded application slice. A trailing raw CR is paired by the next write or flush.