Ice

Enum ACMHeartbeat

java.lang.Object

java.lang.Enum<ACMHeartbeat>

Ice.ACMHeartbeat

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ACMHeartbeat>

public enum ACMHeartbeat
extends java.lang.Enum<ACMHeartbeat>

Specifies the heartbeat semantics for Active Connection Management.

Enum Constant Summary

Enum Constants

Enum Constant and Description
HeartbeatAlways Send a heartbeat at regular intervals until the connection is closed.
HeartbeatOff Disables heartbeats.
HeartbeatOnIdle Send a heartbeat at regular intervals when the connection is idle.
HeartbeatOnInvocation Send a heartbeat at regular intervals if the connection is idle and only if there are pending dispatch.

Method Summary

Modifier and Type	Method and Description
int	value()
static ACMHeartbeat	valueOf(int __v)
static ACMHeartbeat	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ACMHeartbeat[]	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

HeartbeatOff

public static final ACMHeartbeat HeartbeatOff

Disables heartbeats.

HeartbeatOnInvocation

public static final ACMHeartbeat HeartbeatOnInvocation

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 Detail

values

public static ACMHeartbeat[] 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 (ACMHeartbeat c : ACMHeartbeat.values())
    System.out.println(c);

Returns:

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

valueOf

public static ACMHeartbeat valueOf(java.lang.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:

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

java.lang.NullPointerException - if the argument is null

value

public int value()

valueOf

public static ACMHeartbeat valueOf(int __v)