Top Inners Fields Methods
org.apache.sshd.common.session

public Interface SessionHeartbeatController

extends PropertyResolver
Known Direct Subinterfaces
org.apache.sshd.common.session.SessionContext
Imports
java.time.Duration, java.util.EnumSet, .Objects, .Set, java.util.concurrent.TimeUnit, org.apache.sshd.common.CommonModuleProperties, .PropertyResolver, org.apache.sshd.common.util.GenericUtils
Author
Apache MINA SSHD Project

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
SessionHeartbeatController.HeartbeatType

Field Summary

Inherited from org.apache.sshd.common.PropertyResolver:
EMPTY

Method Summary

Modifier and TypeMethod and Description
public default void
disableSessionHeartbeat()

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

public default Duration
getSessionHeartbeatInterval()

public default SessionHeartbeatController.HeartbeatType
getSessionHeartbeatType()

public default void
setSessionHeartbeat(SessionHeartbeatController.HeartbeatType type, TimeUnit unit, long count)

public default void
setSessionHeartbeat(SessionHeartbeatController.HeartbeatType
The type of heartbeat to use
type, Duration
The (never null) heartbeat interval - its milliseconds value is used
interval)

Set the session heartbeat

Inherited from org.apache.sshd.common.PropertyResolver:
getBooleangetBooleanPropertygetCharsetgetIntegergetIntPropertygetLonggetLongPropertygetObjectgetParentPropertyResolvergetPropertiesgetStringgetStringPropertyisEmptyisEmpty

Method Detail

disableSessionHeartbeatback to summary
public default void disableSessionHeartbeat()

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

getSessionHeartbeatIntervalback to summary
public default Duration getSessionHeartbeatInterval()
getSessionHeartbeatTypeback to summary
public default SessionHeartbeatController.HeartbeatType getSessionHeartbeatType()
setSessionHeartbeatback to summary
public default void setSessionHeartbeat(SessionHeartbeatController.HeartbeatType type, TimeUnit unit, long count)
setSessionHeartbeatback to summary
public default void setSessionHeartbeat(SessionHeartbeatController.HeartbeatType type, Duration interval)

Set the session heartbeat

Parameters
type:SessionHeartbeatController.HeartbeatType

The type of heartbeat to use

interval:Duration

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

org.apache.sshd.common.session back to summary

public final Enum SessionHeartbeatController.HeartbeatType

extends Enum<SessionHeartbeatController.HeartbeatType>
Class Inheritance

Field Summary

Modifier and TypeField and Description
public static final SessionHeartbeatController.HeartbeatType
IGNORE

Use SSH_MSG_IGNORE packets

public static final SessionHeartbeatController.HeartbeatType
NONE

No heartbeat

public static final SessionHeartbeatController.HeartbeatType
RESERVED

Custom mechanism via ReservedSessionMessagesHandler

public static final Set<SessionHeartbeatController.HeartbeatType>
VALUES

Constructor Summary

AccessConstructor and Description
private
HeartbeatType()

Method Summary

Modifier and TypeMethod and Description
public static SessionHeartbeatController.HeartbeatType
fromName(String name)

public static SessionHeartbeatController.HeartbeatType
valueOf(String name)

public static SessionHeartbeatController.HeartbeatType[]
values()

Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

IGNOREback to summary
public static final SessionHeartbeatController.HeartbeatType IGNORE

Use SSH_MSG_IGNORE packets

NONEback to summary
public static final SessionHeartbeatController.HeartbeatType NONE

No heartbeat

RESERVEDback to summary
public static final SessionHeartbeatController.HeartbeatType RESERVED

Custom mechanism via ReservedSessionMessagesHandler

VALUESback to summary
public static final Set<SessionHeartbeatController.HeartbeatType> VALUES

Constructor Detail

HeartbeatTypeback to summary
private HeartbeatType()

Method Detail

fromNameback to summary
public static SessionHeartbeatController.HeartbeatType fromName(String name)
valueOfback to summary
public static SessionHeartbeatController.HeartbeatType valueOf(String name)
valuesback to summary
public static SessionHeartbeatController.HeartbeatType[] values()