Top Description Fields Constructors Methods
org.apache.sshd.client.session

public Class ClientConnectionService

extends AbstractConnectionService
implements ClientSessionHolder
Class Inheritance
All Implemented Interfaces
org.apache.sshd.client.session.ClientSessionHolder
Imports
java.io.IOException, java.time.Duration, java.util.concurrent.ScheduledExecutorService, .ScheduledFuture, .TimeUnit, java.util.concurrent.atomic.AtomicInteger, org.apache.sshd.agent.common.AgentForwardSupport, org.apache.sshd.common.FactoryManager, .SshConstants, .SshException, org.apache.sshd.common.future.GlobalRequestFuture, org.apache.sshd.common.io.IoWriteFuture, org.apache.sshd.common.kex.KexState, org.apache.sshd.common.session.Session, org.apache.sshd.common.session.helpers.AbstractConnectionService, org.apache.sshd.common.util.GenericUtils, org.apache.sshd.common.util.buffer.Buffer, org.apache.sshd.core.CoreModuleProperties, org.apache.sshd.server.x11.X11ForwardSupport
Client side ssh-connection service.
Author
Apache MINA SSHD Project

Field Summary

Modifier and TypeField and Description
protected ScheduledFuture<?>
clientHeartbeat

Non-null only if using the "keep-alive" request mechanism

protected final Duration
heartbeatInterval

protected final int
heartbeatMaxNoReply

protected final String
heartbeatRequest

protected final AtomicInteger
outstandingHeartbeats

Inherited from org.apache.sshd.common.session.helpers.AbstractConnectionService:
channelsDEFAULT_SESSION_IGNORE_HEARTBEAT_STRINGheartbeatCountnextChannelIdRESPONSE_BUFFER_GROWTH_FACTOR

Constructor Summary

AccessConstructor and Description
public
ClientConnectionService(AbstractClientSession s)

Method Summary

Modifier and TypeMethod and Description
protected int
configureMaxNoReply()

public AgentForwardSupport
getAgentForwardSupport()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.getAgentForwardSupport.

Implements org.apache.sshd.common.session.ConnectionService.getAgentForwardSupport.

public final ClientSession
getClientSession()

Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

public AbstractClientSession
getSession()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.getSession.

Implements org.apache.sshd.common.session.SessionHolder.getSession.

public X11ForwardSupport
getX11ForwardSupport()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.getX11ForwardSupport.

Implements org.apache.sshd.common.session.ConnectionService.getX11ForwardSupport.

protected boolean
sendHeartBeat()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.sendHeartBeat.

Sends a heartbeat message/packet

public void
start()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.start.

Implements org.apache.sshd.common.Service.start.

protected synchronized ScheduledFuture<?>
startHeartBeat()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.startHeartBeat.

protected synchronized void
stopHeartBeat()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.stopHeartBeat.

Inherited from org.apache.sshd.common.session.helpers.AbstractConnectionService:
addPortForwardingEventListeneraddPortForwardingEventListenerManagerchannelClosechannelDatachannelEofchannelExtendedDatachannelFailurechannelOpenchannelOpenConfirmationchannelOpenFailurechannelRequestchannelSuccesschannelWindowAdjustcreateAgentForwardSupportcreateForwardingFiltercreateX11ForwardSupportfutureDonegetChannelgetChannelgetChannelsgetForwardergetInnerCloseablegetNextChannelIdgetPortForwardingEventListenerProxygetPropertiesgetRegisteredManagersgetUnknownChannelReferenceHandlerglobalRequesthandleUnknownRequestisAllowMoreSessionspreCloseprocessregisterChannelremovePortForwardingEventListenerremovePortForwardingEventListenerManagerrequestFailurerequestSuccessresolveUnknownChannelReferenceHandlersendChannelOpenFailuresendGlobalResponsesetAllowMoreSessionssetUnknownChannelReferenceHandlertoStringunregisterChannel

Field Detail

clientHeartbeatback to summary
protected ScheduledFuture<?> clientHeartbeat

Non-null only if using the "keep-alive" request mechanism

heartbeatIntervalback to summary
protected final Duration heartbeatInterval
heartbeatMaxNoReplyback to summary
protected final int heartbeatMaxNoReply
heartbeatRequestback to summary
protected final String heartbeatRequest
outstandingHeartbeatsback to summary
protected final AtomicInteger outstandingHeartbeats

Constructor Detail

ClientConnectionServiceback to summary
public ClientConnectionService(AbstractClientSession s) throws SshException

Method Detail

configureMaxNoReplyback to summary
protected int configureMaxNoReply()
getAgentForwardSupportback to summary
public AgentForwardSupport getAgentForwardSupport()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.getAgentForwardSupport.

Implements org.apache.sshd.common.session.ConnectionService.getAgentForwardSupport.

Annotations
@Override
getClientSessionback to summary
public final ClientSession getClientSession()

Implements org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

Returns:ClientSession

Doc from org.apache.sshd.client.session.ClientSessionHolder.getClientSession.

The underlying ClientSession used

Annotations
@Override
getSessionback to summary
public AbstractClientSession getSession()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.getSession.

Implements org.apache.sshd.common.session.SessionHolder.getSession.

Annotations
@Override
getX11ForwardSupportback to summary
public X11ForwardSupport getX11ForwardSupport()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.getX11ForwardSupport.

Implements org.apache.sshd.common.session.ConnectionService.getX11ForwardSupport.

Annotations
@Override
sendHeartBeatback to summary
protected boolean sendHeartBeat()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.sendHeartBeat.

Doc from org.apache.sshd.common.session.helpers.AbstractConnectionService.sendHeartBeat.

Sends a heartbeat message/packet

Returns:boolean

true if heartbeat successfully sent

Annotations
@Override
startback to summary
public void start()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.start.

Implements org.apache.sshd.common.Service.start.

Annotations
@Override
startHeartBeatback to summary
protected synchronized ScheduledFuture<?> startHeartBeat()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.startHeartBeat.

Annotations
@Override
stopHeartBeatback to summary
protected synchronized void stopHeartBeat()

Overrides org.apache.sshd.common.session.helpers.AbstractConnectionService.stopHeartBeat.

Annotations
@Override