org.apache.sshd.common.channel

Class AbstractChannel

java.lang.Object

org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

org.apache.sshd.common.channel.AbstractChannel

All Implemented Interfaces:

Channel, Closeable

Direct Known Subclasses:

AbstractClientChannel, AbstractServerChannel

public abstract class AbstractChannel
extends CloseableUtils.AbstractInnerCloseable
implements Channel

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	AbstractChannel.GracefulChannelCloseable
protected static class	AbstractChannel.GracefulState

Nested classes/interfaces inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

CloseableUtils.AbstractCloseable.State

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PACKET_SIZE
static int	DEFAULT_WINDOW_SIZE
protected boolean	eof
protected DefaultCloseFuture	gracefulFuture
protected AtomicReference<AbstractChannel.GracefulState>	gracefulState
protected List<RequestHandler<Channel>>	handlers
protected int	id
protected Window	localWindow
protected int	recipient
protected Window	remoteWindow
protected ConnectionService	service
protected Session	session

Fields inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

closeFuture, lock, log, state

Constructor Summary

Constructors

Constructor and Description
AbstractChannel()

Method Summary

Methods

Modifier and Type	Method and Description
void	addRequestHandler(RequestHandler<Channel> handler)
protected void	configureWindow()
protected void	doCloseImmediately() doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation.
protected abstract void	doWriteData(byte[] data, int off, int len)
protected abstract void	doWriteExtendedData(byte[] data, int off, int len)
int	getId()
protected Closeable	getInnerCloseable()
Window	getLocalWindow()
int	getRecipient()
Window	getRemoteWindow()
Session	getSession()
void	handleClose()
void	handleData(Buffer buffer)
void	handleEof()
void	handleExtendedData(Buffer buffer)
void	handleFailure()
void	handleRequest(Buffer buffer)
void	handleWindowAdjust(Buffer buffer)
void	init(ConnectionService service, Session session, int id)
protected void	notifyStateChanged()
protected void	sendEof()
protected void	sendWindowAdjust(int len)
String	toString()
protected void	writePacket(Buffer buffer)

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractInnerCloseable

doCloseGracefully

Methods inherited from class org.apache.sshd.common.util.CloseableUtils.AbstractCloseable

builder, close, isClosed, isClosing, preClose

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.sshd.common.Channel

close, handleOpenFailure, handleOpenSuccess, open

Methods inherited from interface org.apache.sshd.common.Closeable

isClosed, isClosing

Field Detail

DEFAULT_WINDOW_SIZE

public static final int DEFAULT_WINDOW_SIZE

See Also:

Constant Field Values

DEFAULT_PACKET_SIZE

public static final int DEFAULT_PACKET_SIZE

See Also:

Constant Field Values

localWindow

protected final Window localWindow

remoteWindow

protected final Window remoteWindow

service

protected ConnectionService service

session

protected Session session

id

protected int id

recipient

protected int recipient

eof

protected volatile boolean eof

gracefulState

protected AtomicReference<AbstractChannel.GracefulState> gracefulState

gracefulFuture

protected final DefaultCloseFuture gracefulFuture

handlers

protected final List<RequestHandler<Channel>> handlers

Constructor Detail

AbstractChannel

public AbstractChannel()

Method Detail

addRequestHandler

public void addRequestHandler(RequestHandler<Channel> handler)

getId

public int getId()

Specified by:

getId in interface Channel

getRecipient

public int getRecipient()

Specified by:

getRecipient in interface Channel

getLocalWindow

public Window getLocalWindow()

Specified by:

getLocalWindow in interface Channel

getRemoteWindow

public Window getRemoteWindow()

Specified by:

getRemoteWindow in interface Channel

getSession

public Session getSession()

Specified by:

getSession in interface Channel

handleRequest

public void handleRequest(Buffer buffer)
                   throws IOException

Specified by:

handleRequest in interface Channel

Throws:

IOException

init

public void init(ConnectionService service,
        Session session,
        int id)

Specified by:

init in interface Channel

notifyStateChanged

protected void notifyStateChanged()

handleClose

public void handleClose()
                 throws IOException

Specified by:

handleClose in interface Channel

Throws:

IOException

getInnerCloseable

protected Closeable getInnerCloseable()

Specified by:

getInnerCloseable in class CloseableUtils.AbstractInnerCloseable

doCloseImmediately

protected void doCloseImmediately()

Description copied from class: CloseableUtils.AbstractCloseable

doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation. It may be called concurrently while preClose() or doCloseGracefully is executing

Overrides:

doCloseImmediately in class CloseableUtils.AbstractInnerCloseable

writePacket

protected void writePacket(Buffer buffer)
                    throws IOException

Throws:

IOException

handleData

public void handleData(Buffer buffer)
                throws IOException

Specified by:

handleData in interface Channel

Throws:

IOException

handleExtendedData

public void handleExtendedData(Buffer buffer)
                        throws IOException

Specified by:

handleExtendedData in interface Channel

Throws:

IOException

handleEof

public void handleEof()
               throws IOException

Specified by:

handleEof in interface Channel

Throws:

IOException

handleWindowAdjust

public void handleWindowAdjust(Buffer buffer)
                        throws IOException

Specified by:

handleWindowAdjust in interface Channel

Throws:

IOException

handleFailure

public void handleFailure()
                   throws IOException

Specified by:

handleFailure in interface Channel

Throws:

IOException

doWriteData

protected abstract void doWriteData(byte[] data,
               int off,
               int len)
                             throws IOException

Throws:

IOException

doWriteExtendedData

protected abstract void doWriteExtendedData(byte[] data,
                       int off,
                       int len)
                                     throws IOException

Throws:

IOException

sendEof

protected void sendEof()
                throws IOException

Throws:

IOException

configureWindow

protected void configureWindow()

sendWindowAdjust

protected void sendWindowAdjust(int len)
                         throws IOException

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object