org.apache.sshd.common

Interface Channel

All Superinterfaces:

Closeable

All Known Implementing Classes:

AbstractChannel, AbstractClientChannel, AbstractServerChannel, AgentForwardedChannel, AgentForwardedChannel, ChannelAgentForwarding, ChannelAgentForwarding, ChannelDirectTcpip, ChannelExec, ChannelSession, ChannelSession, ChannelShell, ChannelSubsystem, TcpipClientChannel, TcpipServerChannel, X11ForwardSupport.ChannelForwardedX11

public interface Channel
extends Closeable

TODO Add javadoc

Author:

Apache MINA SSHD Project

Method Summary

Methods

Modifier and Type	Method and Description
CloseFuture	close(boolean immediately) Close this resource asynchronously and return a future.
int	getId()
Window	getLocalWindow()
int	getRecipient()
Window	getRemoteWindow()
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(ConnectionService service, 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()

getRecipient

int getRecipient()

getLocalWindow

Window getLocalWindow()

getRemoteWindow

Window getRemoteWindow()

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)

Description copied from interface: Closeable

Close this resource asynchronously and return a future. Resources support two closing modes: a graceful mode which will cleanly close the resource and an immediate mode which will close the resources abruptly.

Specified by:

close in interface Closeable

Parameters:

immediately - true if the resource should be shut down abruptly, false for a graceful close

Returns:

a future

init

void init(ConnectionService service,
        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