com.sun.xml.ws.rx.rm.api

Enum ReliableMessagingFeature.BackoffAlgorithm

java.lang.Object

java.lang.Enum<ReliableMessagingFeature.BackoffAlgorithm>

com.sun.xml.ws.rx.rm.api.ReliableMessagingFeature.BackoffAlgorithm

All Implemented Interfaces:

Serializable, Comparable<ReliableMessagingFeature.BackoffAlgorithm>

Enclosing class:

ReliableMessagingFeature

public static enum ReliableMessagingFeature.BackoffAlgorithm
extends Enum<ReliableMessagingFeature.BackoffAlgorithm>

Defines the enumeration of all possible backoff algortihms that can be applied for to message retransmission.

See Also:

BackoffAlgorithm#LINEAR, EXPONENTIAL

Enum Constant Summary

Enum Constants

Enum Constant and Description
CONSTANT This algorithm ensures that a message retransmission rate remains constant at all times.
EXPONENTIAL This algorithm ensures that a message retransmission rate is multiplicatively decreased with each resend of the particular message.

Method Summary

Modifier and Type	Method and Description
static ReliableMessagingFeature.BackoffAlgorithm	getDefault() Provides a default back-off algorithm value.
abstract long	getDelayInMillis(int resendAttemptNumber, long baseRate) Calculates the delay before the next possible scheduled resume time based on the resend attempt number.
static ReliableMessagingFeature.BackoffAlgorithm	parse(String name)
static ReliableMessagingFeature.BackoffAlgorithm	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReliableMessagingFeature.BackoffAlgorithm[]	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

CONSTANT

public static final ReliableMessagingFeature.BackoffAlgorithm CONSTANT

This algorithm ensures that a message retransmission rate remains constant at all times.

See Also:

ReliableMessagingFeature.BackoffAlgorithm

EXPONENTIAL

public static final ReliableMessagingFeature.BackoffAlgorithm EXPONENTIAL

This algorithm ensures that a message retransmission rate is multiplicatively decreased with each resend of the particular message.

See Also:

ReliableMessagingFeature.BackoffAlgorithm

Method Detail

values

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

Returns:

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

valueOf

public static ReliableMessagingFeature.BackoffAlgorithm 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

parse

public static ReliableMessagingFeature.BackoffAlgorithm parse(String name)

getDefault

public static ReliableMessagingFeature.BackoffAlgorithm getDefault()

Provides a default back-off algorithm value.

Returns:

a default back-off algorithm value. Currently returns CONSTANT.

See Also:

ReliableMessagingFeature.BackoffAlgorithm

getDelayInMillis

public abstract long getDelayInMillis(int resendAttemptNumber,
                                      long baseRate)

Calculates the delay before the next possible scheduled resume time based on the resend attempt number.

Parameters:

resendAttemptNumber - number of the resend attempt for a message

baseRate - base resend interval

Returns:

next scheduled resume time