com.sshtools.common.ssh

Interface ChannelEventListener

public interface ChannelEventListener

Interface for receiving Channel events (currently only supports the close event).

Author:

Lee David Painter

Method Summary

Modifier and Type	Method and Description
default void	onChannelClose(Channel channel) The channel has been closed
default void	onChannelClosing(Channel channel) The channel is closing, but has not sent its SSH_MSG_CHANNEL_CLOSE
default void	onChannelDataIn(Channel channel, java.nio.ByteBuffer buffer) Data has been received on the channel.
default void	onChannelDataOut(Channel channel, java.nio.ByteBuffer buffer) Data has been sent on the channel.
default void	onChannelEOF(Channel channel) The channel has received an EOF from the remote client
default void	onChannelError(Channel channel, java.lang.Throwable e) Called when a channel is disconnected because of a connection loss.
default void	onChannelExtendedData(Channel channel, java.nio.ByteBuffer buffer, int type) Data has been received on the extended channel.
default void	onChannelOpen(Channel channel) The channel has been opened.
default void	onWindowAdjust(Channel channel, long currentWindowSpace) When the remote side adjusts its window.

Method Detail

onChannelOpen

default void onChannelOpen(Channel channel)

The channel has been opened.

Parameters:

channel - channel

onChannelClose

default void onChannelClose(Channel channel)

The channel has been closed

Parameters:

channel - channel

onChannelEOF

default void onChannelEOF(Channel channel)

The channel has received an EOF from the remote client

Parameters:

channel -

channel - channel

onChannelError

default void onChannelError(Channel channel,
                            java.lang.Throwable e)

Called when a channel is disconnected because of a connection loss. You may still receive onChannelClose event after this.

Parameters:

channel - channel

onChannelClosing

default void onChannelClosing(Channel channel)

The channel is closing, but has not sent its SSH_MSG_CHANNEL_CLOSE

Parameters:

channel - Channel

onWindowAdjust

default void onWindowAdjust(Channel channel,
                            long currentWindowSpace)

When the remote side adjusts its window.

Parameters:

channel - channel

currentWindowSpace - current window space

onChannelDataIn

default void onChannelDataIn(Channel channel,
                             java.nio.ByteBuffer buffer)

Data has been received on the channel. The buffer provided is the same buffer that will be passed on to any thread reading the channels streams.

Parameters:

channel - Channel

buffer - buffer

onChannelExtendedData

default void onChannelExtendedData(Channel channel,
                                   java.nio.ByteBuffer buffer,
                                   int type)

Data has been received on the extended channel. The buffer provided is the same buffer that will be passed on to any thread reading the channels streams.

Parameters:

channel - Channel

buffer - buffer

type - type

onChannelDataOut

default void onChannelDataOut(Channel channel,
                              java.nio.ByteBuffer buffer)

Data has been sent on the channel. The buffer provided is the same buffer that will be passed on to any thread writing the channels streams.

Parameters:

channel - Channel

buffer - buffer