Interface Session.Shell
- All Superinterfaces:
AutoCloseable
,Channel
,Closeable
,ErrorNotifiable
,SSHPacketHandler
- All Known Implementing Classes:
SessionChannel
- Enclosing interface:
Session
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 TypeMethodDescriptionWhether the client can do local flow control usingcontrol-S
andcontrol-Q
.void
changeWindowDimensions
(int cols, int rows, int width, int height) Sends a window dimension change message.Returns the shell'sstderr
stream.void
Send a signal.Methods inherited from interface net.schmizz.sshj.connection.channel.Channel
close, getAutoExpand, getID, getInputStream, getLocalMaxPacketSize, getLocalWinSize, getLoggerFactory, getOutputStream, getRecipient, getRemoteCharset, getRemoteMaxPacketSize, getRemoteWinSize, getType, isEOF, isOpen, join, join, setAutoExpand
Methods inherited from interface net.schmizz.sshj.common.ErrorNotifiable
notifyError
Methods inherited from interface net.schmizz.sshj.common.SSHPacketHandler
handle
-
Method Details
-
canDoFlowControl
Boolean canDoFlowControl()Whether the client can do local flow control usingcontrol-S
andcontrol-Q
.- Returns:
- boolean value indicating whether 'client can do', or
null
if no such information was received
-
changeWindowDimensions
Sends a window dimension change message.- Parameters:
cols
- terminal width, columnsrows
- terminal height, rowswidth
- terminal width, pixelsheight
- terminal height, pixels- Throws:
TransportException
-
getErrorStream
InputStream getErrorStream()Returns the shell'sstderr
stream. -
signal
Send a signal.- Parameters:
signal
- the signal- Throws:
TransportException
- if error sending the signal
-