Top Description Fields Constructors Methods
org.apache.sshd.server.channel

public abstract Class AbstractServerChannel

extends AbstractChannel
implements ServerChannel
Class Inheritance
All Implemented Interfaces
org.apache.sshd.server.channel.ServerChannel, org.apache.sshd.server.session.ServerSessionHolder, org.apache.sshd.common.channel.Channel, org.apache.sshd.common.Closeable, java.nio.channels.Channel, java.io.Closeable, java.lang.AutoCloseable, org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolverManager, org.apache.sshd.common.channel.throttle.ChannelStreamWriterResolver, org.apache.sshd.common.AttributeStore, org.apache.sshd.common.AttributeRepository, org.apache.sshd.common.PropertyResolver, org.apache.sshd.common.channel.ChannelListenerManager, org.apache.sshd.common.channel.ChannelIdentifier, org.apache.sshd.common.session.SessionHolder, org.apache.sshd.common.session.SessionContextHolder
Known Direct Subclasses
org.apache.sshd.server.channel.ChannelSession, org.apache.sshd.server.forward.TcpipServerChannel, org.apache.sshd.agent.local.ChannelAgentForwarding, org.apache.sshd.agent.unix.ChannelAgentForwarding
Imports
java.io.IOException, java.util.Collection, .Collections, .Objects, java.util.concurrent.atomic.AtomicBoolean, org.apache.sshd.client.future.DefaultOpenFuture, .OpenFuture, org.apache.sshd.common.FactoryManager, .SshConstants, org.apache.sshd.common.channel.AbstractChannel, .Channel, .RemoteWindow, .RequestHandler, org.apache.sshd.common.session.Session, org.apache.sshd.common.util.ExceptionUtils, org.apache.sshd.common.util.buffer.Buffer, org.apache.sshd.common.util.threads.CloseableExecutorService

TODO Add javadoc
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
protected final AtomicBoolean
Inherited from org.apache.sshd.common.channel.AbstractChannel:
channelListenerProxychannelListenerscloseSignaledDEFAULT_PACKET_VALIDATOReofReceivedeofSentgracefulFuturegracefulStateinitializedRESPONSE_BUFFER_GROWTH_FACTORserviceunregisterSignaled

Constructor Summary

AccessConstructor and Description
protected
protected

Method Summary

Modifier and TypeMethod and Description
protected OpenFuture
doInit(Buffer buffer)

public void
handleOpenFailure(Buffer
Incoming Buffer that triggered the call

Note

the buffer's read position is exactly after the information that read to this call was decoded

buffer
)

Implements org.apache.sshd.common.channel.Channel.handleOpenFailure.

For a client channel, this method will be called internally by the session when the server has rejected this channel opening.

public void
handleOpenSuccess(long
Recipient identifier (UINT32 represented as a long)
recipient
,
long
Read/Write window size (uint32)
rwSize
,
long
Preferred maximum packet size (uint32)
packetSize
,
Buffer
Incoming Buffer that triggered the call

Note

the buffer's read position is exactly after the information that read to this call was decoded

buffer
)

Implements org.apache.sshd.common.channel.Channel.handleOpenSuccess.

For a client channel, this method will be called internally by the session when the confirmation has been received.

public OpenFuture
open(long
Recipient identifier (UINT32 represented as a long)
recipient
,
long
Read/Write window size (uint32)
rwSize
,
long
Preferred maximum packet size (uint32)
packetSize
,
Buffer
Incoming Buffer that triggered the call

Note

the buffer's read position is exactly after the information that read to this call was decoded

buffer
)

Implements org.apache.sshd.common.channel.Channel.open.

For a server channel, this method will actually open the channel

protected void
Inherited from org.apache.sshd.common.channel.AbstractChannel:
addChannelListeneraddPendingRequestaddRequestHandlerattributeKeysclearAttributescomputeAttributeIfAbsentconfigureWindowdoWriteDatadoWriteExtendedDatagetAttributegetAttributesCountgetChannelIdgetChannelListenerProxygetChannelStreamWriterResolvergetExecutorServicegetInnerCloseablegetLocalWindowgetPacketValidatorgetParentPropertyResolvergetPropertiesgetRecipientgetRemoteWindowgetRequestHandlersgetSessionhandleChannelRegistrationResulthandleChannelRequesthandleChannelUnregistrationhandleClosehandleDatahandleEofhandleExtendedDatahandleFailurehandleInternalRequesthandleRequesthandleSuccesshandleUnknownChannelRequesthandleWindowAdjustinitinvokeChannelSignallerisEofSentisEofSignalledisInitializedmayWritenotifyStateChangednotifyStateChangedpreCloseremoveAttributeremoveChannelListenerremovePendingRequestremoveRequestHandlerresolveChannelStreamWriterResolversendEofsendResponsesendWindowAdjustsetAttributesetChannelStreamWriterResolversetPacketValidatorsetRecipientsignalChannelClosedsignalChannelClosedsignalChannelInitializedsignalChannelInitializedsignalChannelOpenFailuresignalChannelOpenFailuresignalChannelOpenSuccesssignalChannelOpenSuccesstoStringvalidateIncomingDataSizewritePacket

Field Detail

exitStatusSentback to summary
protected final AtomicBoolean exitStatusSent

Constructor Detail

AbstractServerChannelback to summary
protected AbstractServerChannel(CloseableExecutorService executor)
AbstractServerChannelback to summary
protected AbstractServerChannel(String discriminator, Collection<? extends RequestHandler<Channel>> handlers, CloseableExecutorService executor)

Method Detail

doInitback to summary
protected OpenFuture doInit(Buffer buffer)
handleOpenFailureback to summary
public void handleOpenFailure(Buffer buffer)

Implements org.apache.sshd.common.channel.Channel.handleOpenFailure.

Doc from org.apache.sshd.common.channel.Channel.handleOpenFailure.

For a client channel, this method will be called internally by the session when the server has rejected this channel opening.

Parameters
buffer:Buffer

Incoming Buffer that triggered the call

Note

the buffer's read position is exactly after the information that read to this call was decoded

Annotations
@Override
handleOpenSuccessback to summary
public void handleOpenSuccess(long recipient, long rwSize, long packetSize, Buffer buffer) throws IOException

Implements org.apache.sshd.common.channel.Channel.handleOpenSuccess.

Doc from org.apache.sshd.common.channel.Channel.handleOpenSuccess.

For a client channel, this method will be called internally by the session when the confirmation has been received.

Parameters
recipient:long

Recipient identifier (UINT32 represented as a long)

rwSize:long

Read/Write window size (uint32)

packetSize:long

Preferred maximum packet size (uint32)

buffer:Buffer

Incoming Buffer that triggered the call

Note

the buffer's read position is exactly after the information that read to this call was decoded

Annotations
@Override
Exceptions
IOException:
If failed to handle the success
openback to summary
public OpenFuture open(long recipient, long rwSize, long packetSize, Buffer buffer)

Implements org.apache.sshd.common.channel.Channel.open.

Doc from org.apache.sshd.common.channel.Channel.open.

For a server channel, this method will actually open the channel

Parameters
recipient:long

Recipient identifier (UINT32 represented as a long)

rwSize:long

Read/Write window size (uint32)

packetSize:long

Preferred maximum packet size (uint32)

buffer:Buffer

Incoming Buffer that triggered the call

Note

the buffer's read position is exactly after the information that read to this call was decoded

Returns:OpenFuture

An OpenFuture for the channel open request

Annotations
@Override
sendExitStatusback to summary
protected void sendExitStatus(int v) throws IOException