Package org.flasby.net.heartbeat

Enum Class Heartbeater.Policy

java.lang.Object

java.lang.Enum<Heartbeater.Policy>

org.flasby.net.heartbeat.Heartbeater.Policy

All Implemented Interfaces:

Serializable, Comparable<Heartbeater.Policy>, Constable

Enclosing class:

Heartbeater<T>

public static enum Heartbeater.Policy
extends Enum<Heartbeater.Policy>

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALWAYS	means that the heartbeat will always be sent irrespective of other messages sent on the channel.
KEEP_ALIVE	means that the heartbeat will only be sent after a quiet period to indicate the server is still alive.

Method Summary

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

Methods inherited from class java.lang.Enum

compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALWAYS

public static final Heartbeater.Policy ALWAYS

means that the heartbeat will always be sent irrespective of other messages sent on the channel.

KEEP_ALIVE

public static final Heartbeater.Policy KEEP_ALIVE

means that the heartbeat will only be sent after a quiet period to indicate the server is still alive.

Method Details

values

public static Heartbeater.Policy[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Heartbeater.Policy valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null