org.apache.sshd.client.channel

Class ChannelSession

java.lang.Object

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

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

org.apache.sshd.common.channel.AbstractChannel

org.apache.sshd.client.channel.AbstractClientChannel

org.apache.sshd.client.channel.ChannelSession

All Implemented Interfaces:

ClientChannel, Channel, Closeable

Direct Known Subclasses:

ChannelSubsystem, PtyCapableChannelSession

public class ChannelSession
extends AbstractClientChannel

TODO Add javadoc

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.sshd.common.channel.AbstractChannel

AbstractChannel.GracefulChannelCloseable, AbstractChannel.GracefulState

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

CloseableUtils.AbstractCloseable.State

Nested classes/interfaces inherited from interface org.apache.sshd.ClientChannel

ClientChannel.Streaming

Field Summary

Fields inherited from class org.apache.sshd.client.channel.AbstractClientChannel

asyncErr, asyncIn, asyncOut, err, exitSignal, exitStatus, in, invertedErr, invertedIn, invertedOut, opened, openFailureMsg, openFailureReason, openFuture, out, streaming, type

Fields inherited from class org.apache.sshd.common.channel.AbstractChannel

DEFAULT_PACKET_SIZE, DEFAULT_WINDOW_SIZE, eof, gracefulFuture, gracefulState, handlers, id, localWindow, recipient, remoteWindow, service, session

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

closeFuture, lock, log, state

Fields inherited from interface org.apache.sshd.ClientChannel

CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM, CLOSED, EOF, EXIT_SIGNAL, EXIT_STATUS, OPENED, STDERR_DATA, STDOUT_DATA, TIMEOUT

Constructor Summary

Constructors

Constructor and Description
ChannelSession()

Method Summary

Methods

Modifier and Type	Method and Description
protected void	doCloseImmediately() doCloseImmediately is called once and only once with state == Immediate Overriding methods should always call the base implementation.
protected void	doOpen()
protected void	pumpInputStream()
protected int	securedRead(InputStream in, byte[] buf, int off, int len)

Methods inherited from class org.apache.sshd.client.channel.AbstractClientChannel

doWriteData, doWriteExtendedData, getAsyncErr, getAsyncIn, getAsyncOut, getErr, getExitStatus, getIn, getInnerCloseable, getInvertedErr, getInvertedIn, getInvertedOut, getOut, getStreaming, handleOpenFailure, handleOpenSuccess, handleWindowAdjust, open, open, setErr, setIn, setOut, setStreaming, waitFor

Methods inherited from class org.apache.sshd.common.channel.AbstractChannel

addRequestHandler, configureWindow, getId, getLocalWindow, getRecipient, getRemoteWindow, getSession, handleClose, handleData, handleEof, handleExtendedData, handleFailure, handleRequest, init, notifyStateChanged, sendEof, sendWindowAdjust, toString, writePacket

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

close

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

close

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

isClosed, isClosing

Constructor Detail

ChannelSession

public ChannelSession()

Method Detail

doOpen

protected void doOpen()
               throws IOException

Specified by:

doOpen in class AbstractClientChannel

Throws:

IOException

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 AbstractChannel

pumpInputStream

protected void pumpInputStream()

securedRead

protected int securedRead(InputStream in,
              byte[] buf,
              int off,
              int len)
                   throws IOException

Throws:

IOException