com.sun.xml.ws.rm
Enum ReliableMessagingFeature.BackoffAlgorithm

java.lang.Object
  extended by java.lang.Enum<ReliableMessagingFeature.BackoffAlgorithm>
      extended by com.sun.xml.ws.rm.ReliableMessagingFeature.BackoffAlgorithm
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<ReliableMessagingFeature.BackoffAlgorithm>
Enclosing class:
ReliableMessagingFeature

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

This enumeration defines all possible backoff algortihms that can be applied for to message retransmission.

See Also:
LINEAR, EXPONENTIAL

Enum Constant Summary
EXPONENTIAL
          This algorithm ensures that a message retransmission rate is multiplicatively decreased with each resend of the particular message.
LINEAR
          This algorithm ensures that a message retransmission rate remains constant at all times.
 
Method Summary
static ReliableMessagingFeature.BackoffAlgorithm getDefault()
          Provides a default back-off algorithm value.
abstract  long nextResendTime(int resendAttemptNumber, long baseRate)
          Calculates the next possible scheduled resume time based on the resend attempt number.
static ReliableMessagingFeature.BackoffAlgorithm valueOf(java.lang.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're declared.
 
Methods inherited from class java.lang.Enum
clone, compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

LINEAR

public static final ReliableMessagingFeature.BackoffAlgorithm LINEAR
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 final ReliableMessagingFeature.BackoffAlgorithm[] values()
Returns an array containing the constants of this enum type, in the order they're 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're declared

valueOf

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

getDefault

public static ReliableMessagingFeature.BackoffAlgorithm getDefault()
Provides a default back-off algorithm value.

Returns:
a default back-off algorithm value. Currently returns LINEAR.
See Also:
ReliableMessagingFeature.BackoffAlgorithm

nextResendTime

public abstract long nextResendTime(int resendAttemptNumber,
                                    long baseRate)
Calculates 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