org.apache.sshd.common
Interface Channel

All Known Implementing Classes:

AbstractChannel, AbstractClientChannel, AbstractServerChannel, AgentForwardedChannel, AgentForwardedChannel, ChannelAgentForwarding, ChannelAgentForwarding, ChannelDirectTcpip, ChannelDirectTcpip, ChannelExec, ChannelForwardedTcpip, ChannelSession, ChannelSession, ChannelShell, ChannelSubsystem, TcpipForwardSupport.ChannelForwardedTcpip, TcpipForwardSupport.ChannelForwardedTcpip, X11ForwardSupport.ChannelForwardedX11

public interface Channel

TODO Add javadoc

Author:

Apache MINA SSHD Project

Method Summary

CloseFuture	close(boolean immediately)
int	getId()
Window	getLocalWindow()
Session	getSession()
void	handleClose()
void	handleData(Buffer buffer)
void	handleEof()
void	handleExtendedData(Buffer buffer)
void	handleFailure()
void	handleOpenFailure(Buffer buffer) For a client channel, this method will be called internally by the session when the server has rejected this channel opening.
void	handleOpenSuccess(int recipient, int rwsize, int rmpsize, Buffer buffer) For a client channel, this method will be called internally by the session when the confirmation has been received.
void	handleRequest(Buffer buffer)
void	handleWindowAdjust(Buffer buffer)
void	init(Session session, int id)
OpenFuture	open(int recipient, int rwsize, int rmpsize, Buffer buffer) For a server channel, this method will actually open the channel

Method Detail

getId

int getId()

getLocalWindow

Window getLocalWindow()

getSession

Session getSession()

handleClose

void handleClose()
                 throws java.io.IOException

Throws:

java.io.IOException

handleWindowAdjust

void handleWindowAdjust(Buffer buffer)
                        throws java.io.IOException

Throws:

java.io.IOException

handleRequest

void handleRequest(Buffer buffer)
                   throws java.io.IOException

Throws:

java.io.IOException

handleData

void handleData(Buffer buffer)
                throws java.io.IOException

Throws:

java.io.IOException

handleExtendedData

void handleExtendedData(Buffer buffer)
                        throws java.io.IOException

Throws:

java.io.IOException

handleEof

void handleEof()
               throws java.io.IOException

Throws:

java.io.IOException

handleFailure

void handleFailure()
                   throws java.io.IOException

Throws:

java.io.IOException

close

CloseFuture close(boolean immediately)

init

void init(Session session,
          int id)
          throws java.io.IOException

Throws:

java.io.IOException

open

OpenFuture open(int recipient,
                int rwsize,
                int rmpsize,
                Buffer buffer)

For a server channel, this method will actually open the channel

handleOpenSuccess

void handleOpenSuccess(int recipient,
                       int rwsize,
                       int rmpsize,
                       Buffer buffer)
                       throws java.io.IOException

For a client channel, this method will be called internally by the session when the confirmation has been received.

Throws:

java.io.IOException

handleOpenFailure

void handleOpenFailure(Buffer buffer)
                       throws java.io.IOException

For a client channel, this method will be called internally by the session when the server has rejected this channel opening.

Throws:

java.io.IOException