org.apache.sshd.common.session

Interface SessionHeartbeatController

All Superinterfaces:

PropertyResolver

All Known Subinterfaces:

SessionContext

public interface SessionHeartbeatController
extends PropertyResolver

Author:

Apache MINA SSHD Project

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SessionHeartbeatController.HeartbeatType

Field Summary

Fields

Modifier and Type	Field and Description
static long	DEFAULT_CONNECTION_HEARTBEAT_INTERVAL Default value for "session-connection-heartbeat-interval" if none set
static String	SESSION_HEARTBEAT_INTERVAL Property used to register the interval for the heartbeat - if not set or non-positive then disabled
static String	SESSION_HEARTBEAT_TYPE Property used to register the SessionHeartbeatController.HeartbeatType - if non-existent or NONE then disabled.

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

EMPTY

Method Summary

Modifier and Type	Method and 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, Duration interval) Set the session heartbeat
default 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

Field Detail

SESSION_HEARTBEAT_TYPE

static final String SESSION_HEARTBEAT_TYPE

Property used to register the SessionHeartbeatController.HeartbeatType - if non-existent or NONE then disabled. Same if some unknown string value is set as the property value.

See Also:

Constant Field Values

SESSION_HEARTBEAT_INTERVAL

static final 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,
                                 TimeUnit unit,
                                 long count)

setSessionHeartbeat

default void setSessionHeartbeat(SessionHeartbeatController.HeartbeatType type,
                                 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