ConnectBot SSH Library/org.connectbot.sshlib/SshSession

SshSession

interface SshSession : AutoCloseable(source)

Represents an SSH session channel (RFC 4254 section 6).

Session channels are used for interactive shells, command execution, and subsystem invocation (like SFTP).

Inheritors

SessionChannel

Properties

exitInfo

abstract val exitInfo: Deferred<SessionExit?>

Completes with how the remote process terminated once the server reports it (RFC 4254 section 6.10), or with null when the channel closes without an exit-status/exit-signal notification. Servers are not required to send one, so null means unknown, not failure.

isOpen

abstract val isOpen: Boolean

localChannelNumber

abstract val localChannelNumber: Int

remoteChannelNumber

abstract val remoteChannelNumber: Int

stderr

abstract val stderr: ReceiveChannel<ByteArray>

stdout

abstract val stdout: ReceiveChannel<ByteArray>

Functions

abstract override fun close()

read

abstract suspend fun read(): ByteArray?

readExtended

abstract suspend fun readExtended(): Pair<Int, ByteArray>?

Read non-stderr extended data. RFC 4254 data type 1 is exposed exclusively through stderr so the same remote bytes are not buffered twice.

requestExec

abstract suspend fun requestExec(command: String): Boolean

Request execution of a command on this session channel (RFC 4254 section 6.5).

requestPty

abstract suspend fun requestPty(terminalType: String = "xterm", widthChars: Int = 80, heightRows: Int = 24, widthPixels: Int = 0, heightPixels: Int = 0, terminalModes: ByteArray = byteArrayOf(0)): Boolean

requestShell

abstract suspend fun requestShell(): Boolean

requestSubsystem

abstract suspend fun requestSubsystem(name: String): Boolean

Request a subsystem on this session channel (RFC 4254 section 6.5).

resizeTerminal

abstract suspend fun resizeTerminal(widthChars: Int, heightRows: Int, widthPixels: Int, heightPixels: Int): Boolean

sendEof

abstract suspend fun sendEof()

write

abstract suspend fun write(data: ByteArray)

Write data, suspending for channel window credit and transport backpressure.