org.apache.sshd.common.session

Enum SessionHeartbeatController.HeartbeatType

java.lang.Object

java.lang.Enum<SessionHeartbeatController.HeartbeatType>

org.apache.sshd.common.session.SessionHeartbeatController.HeartbeatType

All Implemented Interfaces:

Serializable, Comparable<SessionHeartbeatController.HeartbeatType>

Enclosing interface:

SessionHeartbeatController

public static enum SessionHeartbeatController.HeartbeatType
extends Enum<SessionHeartbeatController.HeartbeatType>

Enum Constant Summary

Enum Constants

Enum Constant and Description
IGNORE Use SSH_MSG_IGNORE packets
NONE No heartbeat
RESERVED Custom mechanism via ReservedSessionMessagesHandler

Field Summary

Fields

Modifier and Type	Field and Description
static Set<SessionHeartbeatController.HeartbeatType>	VALUES

Method Summary

Modifier and Type	Method and Description
static SessionHeartbeatController.HeartbeatType	fromName(String name)
static SessionHeartbeatController.HeartbeatType	valueOf(String name) Returns the enum constant of this type with the specified name.
static SessionHeartbeatController.HeartbeatType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NONE

public static final SessionHeartbeatController.HeartbeatType NONE

No heartbeat

IGNORE

public static final SessionHeartbeatController.HeartbeatType IGNORE

Use SSH_MSG_IGNORE packets

RESERVED

public static final SessionHeartbeatController.HeartbeatType RESERVED

Custom mechanism via ReservedSessionMessagesHandler

Field Detail

VALUES

public static final Set<SessionHeartbeatController.HeartbeatType> VALUES

Method Detail

values

public static SessionHeartbeatController.HeartbeatType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SessionHeartbeatController.HeartbeatType c : SessionHeartbeatController.HeartbeatType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SessionHeartbeatController.HeartbeatType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromName

public static SessionHeartbeatController.HeartbeatType fromName(String name)