public static interface

Session.Shell

implements Channel
net.schmizz.sshj.connection.channel.direct.Session.Shell
Known Indirect Subclasses

Class Overview

Shell API.

Summary

Public Methods
abstract Boolean canDoFlowControl()
Whether the client can do local flow control using control-S and control-Q.
abstract void changeWindowDimensions(int cols, int rows, int width, int height)
Sends a window dimension change message.
abstract InputStream getErrorStream()
Returns the shell's stderr stream.
abstract void signal(Signal signal)
Send a signal.
[Expand]
Inherited Methods
From interface java.io.Closeable
From interface net.schmizz.sshj.common.ErrorNotifiable
From interface net.schmizz.sshj.common.SSHPacketHandler
From interface net.schmizz.sshj.connection.channel.Channel

Public Methods

public abstract Boolean canDoFlowControl ()

Whether the client can do local flow control using control-S and control-Q.

Returns
  • boolean value indicating whether 'client can do', or null if no such information was received

public abstract void changeWindowDimensions (int cols, int rows, int width, int height)

Sends a window dimension change message.

Parameters
cols Terminal width, columns
rows Terminal height, rows
width Terminal width, pixels
height Terminal height, pixels
Throws
TransportException

public abstract InputStream getErrorStream ()

Returns the shell's stderr stream.

public abstract void signal (Signal signal)

Send a signal.

Parameters
signal The signal
Throws
TransportException if error sending the signal