ConnectBot SSH Library/org.connectbot.sshlib.client/SessionChannel

SessionChannel

class SessionChannel : SshSession(source)

Types

Properties

open override 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

open override val isOpen: Boolean

localChannelNumber

open override val localChannelNumber: Int

remoteChannelNumber

open override val remoteChannelNumber: Int

stderr

open override val stderr: ReceiveChannel<ByteArray>

stdout

open override val stdout: ReceiveChannel<ByteArray>

Functions

open override fun close()

read

open suspend override fun read(): ByteArray?

readExtended

open suspend override 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

open suspend override fun requestExec(command: String): Boolean

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

requestPty

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

requestShell

open suspend override fun requestShell(): Boolean

requestSubsystem

open suspend override fun requestSubsystem(name: String): Boolean

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

resizeTerminal

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

sendEof

open suspend override fun sendEof()

write

open suspend override fun write(data: ByteArray)

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