Package org.apache.sshd.common.session

Interface SessionHeartbeatController

All Superinterfaces:

PropertyResolver

All Known Subinterfaces:

ClientFactoryManager, ClientSession, ConnectionService, FactoryManager, ServerFactoryManager, ServerSession, Session, SessionContext

All Known Implementing Classes:

AbstractClientSession, AbstractConnectionService, AbstractFactoryManager, AbstractServerSession, AbstractSession, ClientConnectionService, ClientSessionImpl, ServerConnectionService, ServerSessionImpl, SessionHelper, SshClient, SshServer

public interface SessionHeartbeatController
extends PropertyResolver

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SessionHeartbeatController.HeartbeatType

Field Summary

Fields inherited from interface org.apache.sshd.common.PropertyResolver

EMPTY

Method Summary

Modifier and Type	Method	Description
default void	disableSessionHeartbeat()	Disables the session heartbeat feature - Note: if heartbeat already in progress then it may be ignored.
default java.time.Duration	getSessionHeartbeatInterval()
default SessionHeartbeatController.HeartbeatType	getSessionHeartbeatType()
default void	setSessionHeartbeat(SessionHeartbeatController.HeartbeatType type, java.time.Duration interval)	Set the session heartbeat
default void	setSessionHeartbeat(SessionHeartbeatController.HeartbeatType type, java.util.concurrent.TimeUnit unit, long count)

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

getBoolean, getBooleanProperty, getCharset, getInteger, getIntProperty, getLong, getLongProperty, getObject, getParentPropertyResolver, getProperties, getString, getStringProperty, isEmpty

Method Detail

getSessionHeartbeatType

default SessionHeartbeatController.HeartbeatType getSessionHeartbeatType()

getSessionHeartbeatInterval

default java.time.Duration getSessionHeartbeatInterval()

disableSessionHeartbeat

default void disableSessionHeartbeat()

Disables the session heartbeat feature - Note: if heartbeat already in progress then it may be ignored.

setSessionHeartbeat

default void setSessionHeartbeat(SessionHeartbeatController.HeartbeatType type,
                                 java.util.concurrent.TimeUnit unit,
                                 long count)

setSessionHeartbeat

default void setSessionHeartbeat(SessionHeartbeatController.HeartbeatType type,
                                 java.time.Duration interval)

Set the session heartbeat

Parameters:

type - The type of heartbeat to use

interval - The (never null) heartbeat interval - its milliseconds value is used