net.schmizz.sshj.connection.channel.direct

Interface Session.Shell

All Superinterfaces:

java.lang.AutoCloseable, Channel, java.io.Closeable, ErrorNotifiable, SSHPacketHandler

All Known Implementing Classes:

SessionChannel

Enclosing interface:

Session

public static interface Session.Shell
extends Channel

Shell API.

Nested Class Summary

Nested classes/interfaces inherited from interface net.schmizz.sshj.connection.channel.Channel

Channel.Direct, Channel.Forwarded

Nested classes/interfaces inherited from interface net.schmizz.sshj.common.ErrorNotifiable

ErrorNotifiable.Util

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	canDoFlowControl() Whether the client can do local flow control using control-S and control-Q.
void	changeWindowDimensions(int cols, int rows, int width, int height) Sends a window dimension change message.
java.io.InputStream	getErrorStream() Returns the shell's stderr stream.
void	signal(Signal signal) Send a signal.

Methods inherited from interface net.schmizz.sshj.connection.channel.Channel

close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getLoggerFactory, getOutputStream, getRecipient, getRemoteMaxPacketSize, getRemoteWinSize, getType, isEOF, isOpen, join, join, setAutoExpand

Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler

handle

Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable

notifyError

Method Detail

canDoFlowControl

java.lang.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

changeWindowDimensions

void changeWindowDimensions(int cols,
                            int rows,
                            int width,
                            int height)
                     throws TransportException

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

getErrorStream

java.io.InputStream getErrorStream()

Returns the shell's stderr stream.

signal

void signal(Signal signal)
     throws TransportException

Send a signal.

Parameters:

signal - the signal

Throws:

TransportException - if error sending the signal