Package org.apache.sshd.common.forward
Class TcpipClientChannel
- java.lang.Object
-
- All Implemented Interfaces:
Closeable
,AutoCloseable
,Channel
,ClientChannel
,ClientSessionHolder
,AttributeRepository
,AttributeStore
,Channel
,ChannelListenerManager
,ChannelStreamPacketWriterResolver
,ChannelStreamPacketWriterResolverManager
,Closeable
,ForwardingTunnelEndpointsProvider
,PacketWriter
,PropertyResolver
,SessionContextHolder
,SessionHolder<Session>
,ExecutorServiceCarrier
public class TcpipClientChannel extends AbstractClientChannel implements ForwardingTunnelEndpointsProvider
TODO Add javadoc- Author:
- Apache MINA SSHD Project
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TcpipClientChannel.Type
Type of channel being created.-
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.closeable.AbstractCloseable
AbstractCloseable.State
-
Nested classes/interfaces inherited from interface org.apache.sshd.common.AttributeRepository
AttributeRepository.AttributeKey<T>
-
Nested classes/interfaces inherited from interface org.apache.sshd.client.channel.ClientChannel
ClientChannel.Streaming
-
-
Field Summary
Fields Modifier and Type Field Description protected SshdSocketAddress
localEntry
protected SshdSocketAddress
remote
protected IoSession
serverSession
-
Fields inherited from class org.apache.sshd.client.channel.AbstractClientChannel
asyncErr, asyncIn, asyncOut, err, exitSignalHolder, exitStatusHolder, in, invertedErr, invertedIn, invertedOut, opened, openFailureLang, openFailureMsg, openFailureReason, openFuture, out, streaming
-
Fields inherited from class org.apache.sshd.common.channel.AbstractChannel
channelListenerProxy, channelListeners, eofReceived, eofSent, gracefulFuture, gracefulState, initialized, RESPONSE_BUFFER_GROWTH_FACTOR, service
-
Fields inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
closeFuture, futureLock, state
-
Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
log
-
Fields inherited from interface org.apache.sshd.common.channel.Channel
CHANNEL_EXEC, CHANNEL_SHELL, CHANNEL_SUBSYSTEM
-
Fields inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolver
NONE
-
Fields inherited from interface org.apache.sshd.common.Closeable
CLOSE_WAIT_TIMEOUT, DEFAULT_CLOSE_WAIT_TIMEOUT
-
Fields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY
-
-
Constructor Summary
Constructors Constructor Description TcpipClientChannel(TcpipClientChannel.Type type, IoSession serverSession, SshdSocketAddress remote)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
doOpen()
protected void
doWriteData(byte[] data, int off, long len)
protected void
doWriteExtendedData(byte[] data, int off, long len)
protected Closeable
getInnerCloseable()
OpenFuture
getOpenFuture()
ClientChannelPendingMessagesQueue
getPendingMessagesQueue()
TcpipClientChannel.Type
getTcpipChannelType()
SshdSocketAddress
getTunnelEntrance()
SshdSocketAddress
getTunnelExit()
void
handleEof()
Invoked whenSSH_MSG_CHANNEL_EOF
receivedOpenFuture
open()
protected void
preClose()
preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately.void
updateLocalForwardingEntry(LocalForwardingEntry entry)
-
Methods inherited from class org.apache.sshd.client.channel.AbstractClientChannel
addChannelSignalRequestHandlers, getAsyncErr, getAsyncIn, getAsyncOut, getChannelState, getChannelType, getErr, getExitSignal, getExitStatus, getIn, getInvertedErr, getInvertedIn, getInvertedOut, getOut, getStreaming, handleOpenFailure, handleOpenSuccess, handleWindowAdjust, open, setErr, setIn, setOut, setStreaming, updateCurrentChannelState, waitFor
-
Methods inherited from class org.apache.sshd.common.channel.AbstractChannel
addChannelListener, addPendingRequest, addRequestHandler, attributeKeys, clearAttributes, computeAttributeIfAbsent, configureWindow, getAttribute, getAttributesCount, getChannelListenerProxy, getChannelStreamPacketWriterResolver, getExecutorService, getId, getLocalWindow, getParentPropertyResolver, getProperties, getRecipient, getRemoteWindow, getRequestHandlers, getSession, handleChannelRequest, handleClose, handleData, handleExtendedData, handleFailure, handleInternalRequest, handleRequest, handleSuccess, handleUnknownChannelRequest, init, invokeChannelSignaller, isEofSent, isEofSignalled, isInitialized, notifyStateChanged, notifyStateChanged, removeAttribute, removeChannelListener, removePendingRequest, removeRequestHandler, resolveChannelStreamPacketWriterResolver, sendEof, sendResponse, sendWindowAdjust, setAttribute, setChannelStreamPacketWriterResolver, setRecipient, signalChannelClosed, signalChannelClosed, signalChannelInitialized, signalChannelInitialized, signalChannelOpenFailure, signalChannelOpenFailure, signalChannelOpenSuccess, signalChannelOpenSuccess, toString, validateIncomingDataSize, writePacket
-
Methods inherited from class org.apache.sshd.common.util.closeable.AbstractInnerCloseable
doCloseGracefully, doCloseImmediately
-
Methods inherited from class org.apache.sshd.common.util.closeable.AbstractCloseable
addCloseFutureListener, builder, close, getFutureLock, isClosed, isClosing, removeCloseFutureListener
-
Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean
getSimplifiedLogger
-
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.AttributeRepository
attributeKeys, getAttribute, getAttributesCount
-
Methods inherited from interface org.apache.sshd.common.AttributeStore
clearAttributes, computeAttributeIfAbsent, removeAttribute, setAttribute
-
Methods inherited from interface org.apache.sshd.common.channel.Channel
addRequestHandler, addRequestHandlers, getId, getLocalWindow, getRecipient, getRemoteWindow, getRequestHandlers, handleClose, handleData, handleExtendedData, handleFailure, handleRequest, handleSuccess, init, isEofSignalled, isInitialized, removeRequestHandler, removeRequestHandlers, resolveAttribute
-
Methods inherited from interface org.apache.sshd.common.channel.ChannelListenerManager
addChannelListener, getChannelListenerProxy, removeChannelListener
-
Methods inherited from interface org.apache.sshd.common.channel.throttle.ChannelStreamPacketWriterResolverManager
getChannelStreamPacketWriterResolver, resolveChannelStreamPacketWriter, resolveChannelStreamPacketWriterResolver, setChannelStreamPacketWriterResolver
-
Methods inherited from interface org.apache.sshd.client.channel.ClientChannel
getClientSession
-
Methods inherited from interface org.apache.sshd.common.Closeable
addCloseFutureListener, close, close, isClosed, isClosing, isOpen, removeCloseFutureListener
-
Methods inherited from interface org.apache.sshd.common.io.PacketWriter
writePacket
-
Methods inherited from interface org.apache.sshd.common.PropertyResolver
getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty
-
Methods inherited from interface org.apache.sshd.common.session.SessionHolder
getSession, getSessionContext
-
-
-
-
Field Detail
-
remote
protected final SshdSocketAddress remote
-
serverSession
protected final IoSession serverSession
-
localEntry
protected SshdSocketAddress localEntry
-
-
Constructor Detail
-
TcpipClientChannel
public TcpipClientChannel(TcpipClientChannel.Type type, IoSession serverSession, SshdSocketAddress remote)
-
-
Method Detail
-
getOpenFuture
public OpenFuture getOpenFuture()
-
getTcpipChannelType
public TcpipClientChannel.Type getTcpipChannelType()
-
getPendingMessagesQueue
public ClientChannelPendingMessagesQueue getPendingMessagesQueue()
-
updateLocalForwardingEntry
public void updateLocalForwardingEntry(LocalForwardingEntry entry)
-
open
public OpenFuture open() throws IOException
- Specified by:
open
in interfaceClientChannel
- Overrides:
open
in classAbstractClientChannel
- Throws:
IOException
-
doOpen
protected void doOpen() throws IOException
- Specified by:
doOpen
in classAbstractClientChannel
- Throws:
IOException
-
preClose
protected void preClose()
Description copied from class:AbstractCloseable
preClose is guaranteed to be called before doCloseGracefully or doCloseImmediately. When preClose() is called, isClosing() == true- Overrides:
preClose
in classAbstractChannel
-
getInnerCloseable
protected Closeable getInnerCloseable()
- Overrides:
getInnerCloseable
in classAbstractClientChannel
-
doWriteData
protected void doWriteData(byte[] data, int off, long len) throws IOException
- Overrides:
doWriteData
in classAbstractClientChannel
- Throws:
IOException
-
doWriteExtendedData
protected void doWriteExtendedData(byte[] data, int off, long len) throws IOException
- Overrides:
doWriteExtendedData
in classAbstractClientChannel
- Throws:
IOException
-
getTunnelEntrance
public SshdSocketAddress getTunnelEntrance()
- Specified by:
getTunnelEntrance
in interfaceForwardingTunnelEndpointsProvider
-
getTunnelExit
public SshdSocketAddress getTunnelExit()
- Specified by:
getTunnelExit
in interfaceForwardingTunnelEndpointsProvider
-
handleEof
public void handleEof() throws IOException
Description copied from interface:Channel
Invoked whenSSH_MSG_CHANNEL_EOF
received- Specified by:
handleEof
in interfaceChannel
- Overrides:
handleEof
in classAbstractChannel
- Throws:
IOException
- If failed to handle the message
-
-