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 Modifier and Type Field Description static long
DEFAULT_CONNECTION_HEARTBEAT_INTERVAL
Default value for "session-connection-heartbeat-interval" if none setstatic java.lang.String
SESSION_HEARTBEAT_INTERVAL
Property used to register the interval for the heartbeat - if not set or non-positive then disabledstatic java.lang.String
SESSION_HEARTBEAT_TYPE
Property used to register theSessionHeartbeatController.HeartbeatType
- if non-existent orNONE
then disabled.-
Fields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY
-
-
Method Summary
All Methods Instance Methods Default Methods 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 long
getSessionHeartbeatInterval()
default SessionHeartbeatController.HeartbeatType
getSessionHeartbeatType()
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
-
-
-
-
Field Detail
-
SESSION_HEARTBEAT_TYPE
static final java.lang.String SESSION_HEARTBEAT_TYPE
Property used to register theSessionHeartbeatController.HeartbeatType
- if non-existent orNONE
then disabled. Same if some unknown string value is set as the property value.- See Also:
- Constant Field Values
-
SESSION_HEARTBEAT_INTERVAL
static final java.lang.String SESSION_HEARTBEAT_INTERVAL
Property used to register the interval for the heartbeat - if not set or non-positive then disabled- See Also:
- Constant Field Values
-
DEFAULT_CONNECTION_HEARTBEAT_INTERVAL
static final long DEFAULT_CONNECTION_HEARTBEAT_INTERVAL
Default value for "session-connection-heartbeat-interval" if none set- See Also:
- Constant Field Values
-
-
Method Detail
-
getSessionHeartbeatType
default SessionHeartbeatController.HeartbeatType getSessionHeartbeatType()
-
getSessionHeartbeatInterval
default long 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)
-
-