Use platform-specific window monitoring to call Callback.onResize when the OS determines the terminal window size has changed. You must call setCallback to monitor these events.

actual fun enableWindowResizeEvents()

interruptRead

expect fun interruptRead()

Signal blocking calls to read or readWithTimeout to wake up and return 0.

actual fun interruptRead()

read

expect fun read(buffer: ByteArray, offset: Int, count: Int): Int

Read up to count bytes into buffer at offset from the TTY. The number of bytes read will be returned. 0 will be returned if interruptRead is called while waiting for input. -1 will be returned if the TTY is not interactive.

actual fun read(buffer: ByteArray, offset: Int, count: Int): Int

readWithTimeout

expect fun readWithTimeout(buffer: ByteArray, offset: Int, count: Int, timeoutMillis: Int): Int

Read up to count bytes into buffer at offset from the TTY. The number of bytes read will be returned. 0 will be returned if interruptRead is called while waiting for input, or if at least timeoutMillis have passed without data. -1 will be returned if the TTY is not interactive.

actual fun readWithTimeout(buffer: ByteArray, offset: Int, count: Int, timeoutMillis: Int): Int

reset

expect fun reset()

Reset TTY state.

actual fun reset()

setCallback

expect fun setCallback(callback: Tty.Callback?)

Set or clear the callback used for reporting events about the terminal using platform-specific integration. The callback may be invoked on any thread and must never throw an exception. On Windows the callback will only be invoked during calls to read or readWithTimeout.

actual fun setCallback(callback: Tty.Callback?)

write

expect fun write(buffer: ByteArray, offset: Int, count: Int): Int

Write up to count bytes from buffer at offset to the TTY. The number of bytes written will be returned.

actual fun write(buffer: ByteArray, offset: Int, count: Int): Int