Package com.zeroc.Ice

Enum Class ACMHeartbeat

java.lang.Object

java.lang.Enum<ACMHeartbeat>

com.zeroc.Ice.ACMHeartbeat

All Implemented Interfaces:

Serializable, Comparable<ACMHeartbeat>, Constable

public enum ACMHeartbeat
extends Enum<ACMHeartbeat>

Specifies the heartbeat semantics for Active Connection Management.

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
HeartbeatAlways	Send a heartbeat at regular intervals until the connection is closed.
HeartbeatOff	Disables heartbeats.
HeartbeatOnDispatch	Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatch.
HeartbeatOnIdle	Send a heartbeat at regular intervals when the connection is idle.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

HeartbeatOff

public static final ACMHeartbeat HeartbeatOff

Disables heartbeats.

HeartbeatOnDispatch

public static final ACMHeartbeat HeartbeatOnDispatch

Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatch.

HeartbeatOnIdle

public static final ACMHeartbeat HeartbeatOnIdle

Send a heartbeat at regular intervals when the connection is idle.

HeartbeatAlways

public static final ACMHeartbeat HeartbeatAlways

Send a heartbeat at regular intervals until the connection is closed.

Method Details

values

public static ACMHeartbeat[] 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 ACMHeartbeat 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

value

public int value()

valueOf

public static ACMHeartbeat valueOf(int v)

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:

v - 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