//[ConnectBot Telnet Library](../index.md)/[org.connectbot.telnetlib](index.md) # Package-level declarations ## Types | Name | Summary | |---|---| | [NewlinePolicy](-newline-policy/index.md) | [jvm]
enum [NewlinePolicy](-newline-policy/index.md) : [Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)<[NewlinePolicy](-newline-policy/index.md)> | | [NonBinaryPolicy](-non-binary-policy/index.md) | [jvm]
enum [NonBinaryPolicy](-non-binary-policy/index.md) : [Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)<[NonBinaryPolicy](-non-binary-policy/index.md)> | | [TelnetCommand](-telnet-command/index.md) | [jvm]
enum [TelnetCommand](-telnet-command/index.md) : [Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)<[TelnetCommand](-telnet-command/index.md)>
In-band commands. TCP urgent-data SYNCH is deliberately not represented. | | [TelnetConfig](-telnet-config/index.md) | [jvm]
class [TelnetConfig](-telnet-config/index.md)(terminalTypes: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)> = listOf("UNKNOWN"), val columns: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 0, val rows: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 0, val profile: [TelnetProfile](-telnet-profile/index.md) = TelnetProfile.PASSIVE, val nonBinaryPolicy: [NonBinaryPolicy](-non-binary-policy/index.md) = NonBinaryPolicy.STRICT_ASCII, val newlinePolicy: [NewlinePolicy](-newline-policy/index.md) = NewlinePolicy.PRESERVE_LF, val consumeRecords: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) = false, val charset: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)? = null, val maxSubnegotiationBytes: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 64 * 1024, val inputBudgetBytes: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 256 * 1024, val outputBudgetBytes: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 256 * 1024, val maxPendingEvents: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 8192, val controlBudgetBytes: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html) = 32 * 1024, val charsetTimeoutMillis: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html), val closeTimeoutMillis: [Long](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-long/index.html))
Immutable protocol settings. Terminal capabilities must match the actual emulator. | | [TelnetDirection](-telnet-direction/index.md) | [jvm]
enum [TelnetDirection](-telnet-direction/index.md) : [Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)<[TelnetDirection](-telnet-direction/index.md)>
Negotiation direction: LOCAL is WILL/WONT; REMOTE is DO/DONT. | | [TelnetEffect](-telnet-effect/index.md) | [jvm]
sealed interface [TelnetEffect](-telnet-effect/index.md)
An ordered effect. Outbound arrays are complete frames owned by their recipient. | | [TelnetEngine](-telnet-engine/index.md) | [jvm]
class [TelnetEngine](-telnet-engine/index.md)
Deterministic, single-owner client engine. No sockets, callbacks, or coroutine state. Feed at most [CHUNK_SIZE](-telnet-engine/-companion/-c-h-u-n-k_-s-i-z-e.md) 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](-telnet-engine/start.md) once before other operations and [finish](-telnet-engine/finish.md) once at peer EOF. Invalid slices, dimensions and oversized writes throw IllegalArgumentException. Starting twice or using an unstarted engine throws IllegalStateException. | | [TelnetFailure](-telnet-failure/index.md) | [jvm]
data class [TelnetFailure](-telnet-failure/index.md)(val code: [TelnetFailureCode](-telnet-failure-code/index.md), val message: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html))
An operational failure returned as data; argument and state preconditions still throw. | | [TelnetFailureCode](-telnet-failure-code/index.md) | [jvm]
enum [TelnetFailureCode](-telnet-failure-code/index.md) : [Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)<[TelnetFailureCode](-telnet-failure-code/index.md)>
Stable failure categories returned at public API boundaries. | | [TelnetInput](-telnet-input/index.md) | [jvm]
sealed interface [TelnetInput](-telnet-input/index.md)
Lossless, ordered application input; each Data owns its array. | | [TelnetOption](-telnet-option/index.md) | [jvm]
enum [TelnetOption](-telnet-option/index.md) : [Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)<[TelnetOption](-telnet-option/index.md)>
Options supported by the Telnet client. | | [TelnetOutcome](-telnet-outcome/index.md) | [jvm]
sealed interface [TelnetOutcome](-telnet-outcome/index.md)<out [T](-telnet-outcome/index.md)> | | [TelnetProfile](-telnet-profile/index.md) | [jvm]
enum [TelnetProfile](-telnet-profile/index.md) : [Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)<[TelnetProfile](-telnet-profile/index.md)> | | [TelnetResult](-telnet-result/index.md) | [jvm]
data class [TelnetResult](-telnet-result/index.md)(val consumed: [Int](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html), val effects: [List](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-list/index.html)<[TelnetEffect](-telnet-effect/index.md)>, val failure: [TelnetFailure](-telnet-failure/index.md)? = null)
A bounded processing step, including complete effects preceding any failure. | | [TelnetSession](-telnet-session/index.md) | [jvm]
interface [TelnetSession](-telnet-session/index.md)
Ordered, single-consumer input and concurrent suspend output operations. | | [TelnetSnapshot](-telnet-snapshot/index.md) | [jvm]
data class [TelnetSnapshot](-telnet-snapshot/index.md)(val status: [TelnetStatus](-telnet-status/index.md) = TelnetStatus.OPEN, val localEcho: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) = true, val incomingBinary: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) = false, val outgoingBinary: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) = false, val charset: [String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)? = null, val charsetPending: [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) = false, val failure: [TelnetFailure](-telnet-failure/index.md)? = null) | | [TelnetStatus](-telnet-status/index.md) | [jvm]
enum [TelnetStatus](-telnet-status/index.md) : [Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)<[TelnetStatus](-telnet-status/index.md)> | | [TelnetTransport](-telnet-transport/index.md) | [jvm]
interface [TelnetTransport](-telnet-transport/index.md)
A duplex byte transport. Positive reads make progress; -1 is EOF, zero is only legal for a zero-length request. Write must finish the entire slice. Close must promptly interrupt a suspended read/write and be safe to call repeatedly. | ## Functions | Name | Summary | |---|---| | [createTelnetEngine](create-telnet-engine.md) | [jvm]
fun [createTelnetEngine](create-telnet-engine.md)(config: [TelnetConfig](-telnet-config/index.md) = TelnetConfig()): [TelnetEngine](-telnet-engine/index.md)
Creates a fresh engine after validating configuration. Start it before feeding bytes. | | [openTelnetSession](open-telnet-session.md) | [jvm]
fun [openTelnetSession](open-telnet-session.md)(scope: CoroutineScope, transport: [TelnetTransport](-telnet-transport/index.md), config: [TelnetConfig](-telnet-config/index.md) = TelnetConfig(), workerContext: [CoroutineContext](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.coroutines/-coroutine-context/index.html) = scope.coroutineContext.minusKey(Job)): [TelnetSession](-telnet-session/index.md)
Opens a child session over an already connected transport. The session owns and closes that transport. Each large write is accepted in independent bounded chunks, allowing negotiation and competing operations between chunks. |