org.apache.sshd.common.channel

Class AbstractChannel

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

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

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

org.apache.sshd.common.channel.AbstractChannel

All Implemented Interfaces:

Closeable, AutoCloseable, Channel, ExecutorServiceCarrier, ExecutorServiceConfigurer

Direct Known Subclasses:

AbstractClientChannel, AbstractServerChannel

public abstract class AbstractChannel
extends CloseableUtils.AbstractInnerCloseable
implements Channel, ExecutorServiceConfigurer

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 long	DEFAULT_CHANNEL_CLOSE_TIMEOUT
static int	DEFAULT_PACKET_SIZE
static int	DEFAULT_WINDOW_SIZE
protected AtomicBoolean	eof
protected ExecutorService	executor
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
static Int2IntFunction	RESPONSE_BUFFER_GROWTH_FACTOR Default growth factor function used to resize response buffers
protected ConnectionService	service
protected Session	session
protected boolean	shutdownExecutor

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

closeFuture, lock, state

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractChannel()
protected	AbstractChannel(String discriminator)

Method Summary

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
protected abstract void	doWriteData(byte[] data, int off, int len)
protected abstract void	doWriteExtendedData(byte[] data, int off, int len)
ExecutorService	getExecutorService()
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)
boolean	isEofSignalled()
boolean	isShutdownOnExit()
protected void	notifyStateChanged()
protected void	sendEof()
protected void	sendResponse(Buffer buffer, String req, RequestHandler.Result result, boolean wantReply)
protected void	sendWindowAdjust(int len)
void	setEofSignalled(boolean on)
void	setExecutorService(ExecutorService service)
void	setShutdownOnExit(boolean shutdown)
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 org.apache.sshd.common.util.CloseableUtils.IoBaseCloseable

close, isOpen

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.Channel

close, handleOpenFailure, handleOpenSuccess, open

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

isClosed, isClosing

Methods inherited from interface java.nio.channels.Channel

close, isOpen

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

DEFAULT_CHANNEL_CLOSE_TIMEOUT

public static final long DEFAULT_CHANNEL_CLOSE_TIMEOUT

See Also:

Constant Field Values

RESPONSE_BUFFER_GROWTH_FACTOR

public static final Int2IntFunction RESPONSE_BUFFER_GROWTH_FACTOR

Default growth factor function used to resize response buffers

executor

protected ExecutorService executor

shutdownExecutor

protected boolean shutdownExecutor

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 final AtomicBoolean eof

gracefulState

protected AtomicReference<AbstractChannel.GracefulState> gracefulState

gracefulFuture

protected final DefaultCloseFuture gracefulFuture

handlers

protected final List<RequestHandler<Channel>> handlers

Constructor Detail

AbstractChannel

protected AbstractChannel()

AbstractChannel

protected AbstractChannel(String discriminator)

Method Detail

addRequestHandler

public void addRequestHandler(RequestHandler<Channel> handler)

getId

public int getId()

Returns:

Local channel identifier

getRecipient

public int getRecipient()

Returns:

Remote channel identifier

getLocalWindow

public Window getLocalWindow()

getRemoteWindow

public Window getRemoteWindow()

getSession

public Session getSession()

getExecutorService

public ExecutorService getExecutorService()

Specified by:

getExecutorService in interface ExecutorServiceCarrier

setExecutorService

public void setExecutorService(ExecutorService service)

Specified by:

setExecutorService in interface ExecutorServiceConfigurer

isShutdownOnExit

public boolean isShutdownOnExit()

Specified by:

isShutdownOnExit in interface ExecutorServiceCarrier

Returns:

If true then the ExecutorService.shutdownNow() will be called (unless it is an internally allocated service which is always closed)

setShutdownOnExit

public void setShutdownOnExit(boolean shutdown)

Specified by:

setShutdownOnExit in interface ExecutorServiceConfigurer

handleRequest

public void handleRequest(Buffer buffer)
                   throws IOException

Throws:

IOException

sendResponse

protected void sendResponse(Buffer buffer,
                            String req,
                            RequestHandler.Result result,
                            boolean wantReply)
                     throws IOException

Throws:

IOException

init

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

notifyStateChanged

protected void notifyStateChanged()

handleClose

public void handleClose()
                 throws IOException

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

Throws:

IOException

handleExtendedData

public void handleExtendedData(Buffer buffer)
                        throws IOException

Throws:

IOException

isEofSignalled

public boolean isEofSignalled()

setEofSignalled

public void setEofSignalled(boolean on)

handleEof

public void handleEof()
               throws IOException

Throws:

IOException

handleWindowAdjust

public void handleWindowAdjust(Buffer buffer)
                        throws IOException

Throws:

IOException

handleFailure

public void handleFailure()
                   throws IOException

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