com.maverick.ssh

Interface SshChannel

All Superinterfaces:

SshIO

All Known Subinterfaces:

SshSession, SshTunnel

All Known Implementing Classes:

AgentSocketForwardingChannel, Ssh2Channel, Ssh2Session, SshAbstractChannel

public interface SshChannel
extends SshIO

The base interface for all SSH channels. SSH Channels enable the multiplexing of several unique data channels over a single SSH connection, each channel is identified by an unique ID and provides a set of IO streams for sending and recieving data.

Author:

Lee David Painter

Method Summary

Modifier and Type	Method and Description
void	addChannelEventListener(ChannelEventListener listener) Provides an event listening mechanism.
int	getChannelId() Get the id of this channel.
SshClient	getClient() The SshClient that this channel belongs to
int	getMaximumLocalPacketLength() The maximum packet length supported by this channel.
long	getMaximumLocalWindowSize()
int	getMaximumRemotePacketLength() The maximum packet length supported by this channel.
long	getMaximumRemoteWindowSize()
SshMessageRouter	getMessageRouter() Returns the message router instance to which this channel belongs.
long	getRemoteWindow()
boolean	isClosed() Evaluate whether the channel is closed.
void	removeChannelEventListener(ChannelEventListener listener) Provides an event listening mechanism.
void	setAutoConsumeInput(boolean autoConsumeInput) Automatically consume input data
void	waitForOpen() Wait for a channel to open, be carefull not to call this on a thread that is serving as the connections message pump.

Methods inherited from interface com.maverick.ssh.SshIO

close, getInputStream, getOutputStream

Method Detail

getChannelId

int getChannelId()

Get the id of this channel.

Returns:

the channel id

isClosed

boolean isClosed()

Evaluate whether the channel is closed.

Returns:

true if the channel is closed, otherwise false

addChannelEventListener

void addChannelEventListener(ChannelEventListener listener)

Provides an event listening mechanism.

Parameters:

listener -

removeChannelEventListener

void removeChannelEventListener(ChannelEventListener listener)

Provides an event listening mechanism.

Parameters:

listener -

setAutoConsumeInput

void setAutoConsumeInput(boolean autoConsumeInput)

Automatically consume input data

Parameters:

autoConsumeInput - boolean

getMessageRouter

SshMessageRouter getMessageRouter()

Returns the message router instance to which this channel belongs.

Returns:

waitForOpen

void waitForOpen()

Wait for a channel to open, be carefull not to call this on a thread that is serving as the connections message pump.

getMaximumRemotePacketLength

int getMaximumRemotePacketLength()

The maximum packet length supported by this channel.

Returns:

getMaximumLocalPacketLength

int getMaximumLocalPacketLength()

The maximum packet length supported by this channel.

Returns:

getClient

SshClient getClient()

The SshClient that this channel belongs to

Returns:

getRemoteWindow

long getRemoteWindow()

getMaximumRemoteWindowSize

long getMaximumRemoteWindowSize()

getMaximumLocalWindowSize

long getMaximumLocalWindowSize()