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
-
Nested Class Summary
Nested Classes -
Field Summary
Fields inherited from interface org.apache.sshd.common.PropertyResolver
EMPTY
-
Method Summary
Modifier and TypeMethodDescriptiondefault void
Disables the session heartbeat feature - Note: if heartbeat already in progress then it may be ignored.default Duration
default void
setSessionHeartbeat
(SessionHeartbeatController.HeartbeatType type, Duration interval) Set the session heartbeatdefault void
setSessionHeartbeat
(SessionHeartbeatController.HeartbeatType type, 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 Details
-
getSessionHeartbeatType
-
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, TimeUnit unit, long count) -
setSessionHeartbeat
Set the session heartbeat- Parameters:
type
- The type ofheartbeat
to useinterval
- The (nevernull
) heartbeat interval - its milliseconds value is used
-