com.maverick.ssh.message

Class SshAbstractChannel

java.lang.Object

com.maverick.ssh.message.SshAbstractChannel

All Implemented Interfaces:

SshChannel, SshIO

Direct Known Subclasses:

Ssh2Channel

public abstract class SshAbstractChannel
extends Object
implements SshChannel

Author:

Lee David Painter

Field Summary

Fields

Modifier and Type	Field and Description
static int	CHANNEL_CLOSED
static int	CHANNEL_OPEN
static int	CHANNEL_UNINITIALIZED
protected int	channelid
protected SshMessageRouter	manager
protected SshMessageStore	ms
protected int	state

Constructor Summary

Constructors

Constructor and Description
SshAbstractChannel()

Method Summary

Modifier and Type	Method and Description
int	getChannelId() Get the id of this channel.
SshMessageRouter	getMessageRouter() Returns the message router instance to which this channel belongs.
protected SshMessageStore	getMessageStore()
protected abstract MessageObserver	getStickyMessageIds()
void	idle()
protected void	init(SshMessageRouter manager, int channelid)
boolean	isClosed() Evaluate whether the channel is closed.
protected abstract boolean	processChannelMessage(SshChannelMessage m)
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 class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.maverick.ssh.SshChannel

addChannelEventListener, getClient, getMaximumLocalPacketLength, getMaximumLocalWindowSize, getMaximumRemotePacketLength, getMaximumRemoteWindowSize, getRemoteWindow, removeChannelEventListener, setAutoConsumeInput

Methods inherited from interface com.maverick.ssh.SshIO

close, getInputStream, getOutputStream

Field Detail

CHANNEL_UNINITIALIZED

public static final int CHANNEL_UNINITIALIZED

See Also:

Constant Field Values

CHANNEL_OPEN

public static final int CHANNEL_OPEN

See Also:

Constant Field Values

CHANNEL_CLOSED

public static final int CHANNEL_CLOSED

See Also:

Constant Field Values

channelid

protected int channelid

state

protected int state

manager

protected SshMessageRouter manager

ms

protected SshMessageStore ms

Constructor Detail

SshAbstractChannel

public SshAbstractChannel()

Method Detail

getMessageStore

protected SshMessageStore getMessageStore()
                                   throws SshException

Throws:

SshException

getChannelId

public int getChannelId()

Description copied from interface: SshChannel

Get the id of this channel.

Specified by:

getChannelId in interface SshChannel

Returns:

the channel id

getMessageRouter

public SshMessageRouter getMessageRouter()

Description copied from interface: SshChannel

Returns the message router instance to which this channel belongs.

Specified by:

getMessageRouter in interface SshChannel

Returns:

init

protected void init(SshMessageRouter manager,
                    int channelid)

getStickyMessageIds

protected abstract MessageObserver getStickyMessageIds()

isClosed

public boolean isClosed()

Description copied from interface: SshChannel

Evaluate whether the channel is closed.

Specified by:

isClosed in interface SshChannel

Returns:

true if the channel is closed, otherwise false

waitForOpen

public void waitForOpen()

Description copied from interface: SshChannel

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

Specified by:

waitForOpen in interface SshChannel

processChannelMessage

protected abstract boolean processChannelMessage(SshChannelMessage m)
                                          throws SshException

Throws:

SshException

idle

public void idle()