com.maverick.ssh
Interface SshChannel

All Superinterfaces:
SshIO
All Known Subinterfaces:
SshSession, SshTunnel
All Known Implementing Classes:
Ssh2Session, com.maverick.ssh.message.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
 void addChannelEventListener(ChannelEventListener listener)
          Provides an event listening mechanism.
 int getChannelId()
          Get the id of this channel.
 boolean isClosed()
          Evaluate whether the channel is closed.
 void setAutoConsumeInput(boolean autoConsumeInput)
          Automatically consume input data
 
Methods inherited from interface com.maverick.ssh.SshIO
close, getInputStream, getOutputStream
 

Method Detail

getChannelId

public int getChannelId()
Get the id of this channel.

Returns:
the channel id

isClosed

public boolean isClosed()
Evaluate whether the channel is closed.

Returns:
true if the channel is closed, otherwise false

addChannelEventListener

public void addChannelEventListener(ChannelEventListener listener)
Provides an event listening mechanism.

Parameters:
listener -

setAutoConsumeInput

public void setAutoConsumeInput(boolean autoConsumeInput)
Automatically consume input data

Parameters:
autoConsumeInput - boolean


Copyright © 2003 3SP LTD. All Rights Reserved.