com.latencybusters.lbm
Class UMERecoverySequenceNumberCallbackInfo

java.lang.Object
  com.latencybusters.lbm.UMERecoverySequenceNumberCallbackInfo

public class UMERecoverySequenceNumberCallbackInfo
extends java.lang.Object

UME Recovery sequence number callback info class. Contains information for user-supplied recovery sequence number callbacks.

Since:

UME 2.0

Constructor Summary

UMERecoverySequenceNumberCallbackInfo()
Default constructor; initializes all fields to 0.

UMERecoverySequenceNumberCallbackInfo(int flags, long lowSeqNum, long lowRxReqMaxSeqNum, long highSeqNum, java.lang.Object sourceCbArg, java.lang.String source)
Constructor, initializes fields to the given values.

Method Summary

int	flags() Get recovery sequence number info informational flags.
long	highSequenceNumber() Get high sequence number.
long	lowRxReqMaxSequenceNumber() Get low retransmission request maximum sequence number.
long	lowSequenceNumber() Get low sequence number.
void	setLowSequenceNumber(long lowSeqNum) Set the desired starting low sequence number for recovery events.
java.lang.String	source() Get source name string.
java.lang.Object	sourceClientObject() Get source callback object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

UMERecoverySequenceNumberCallbackInfo

public UMERecoverySequenceNumberCallbackInfo()

Default constructor; initializes all fields to 0.

Since:

UME 2.0

UMERecoverySequenceNumberCallbackInfo

public UMERecoverySequenceNumberCallbackInfo(int flags,
                                             long lowSeqNum,
                                             long lowRxReqMaxSeqNum,
                                             long highSeqNum,
                                             java.lang.Object sourceCbArg,
                                             java.lang.String source)
                                      throws LBMEInvalException

Constructor, initializes fields to the given values.

Parameters:

flags - Informational flags.

lowSeqNum - Low sequence number (can be changed by the application, must be >= 0).

lowRxReqMaxSeqNum - Low retransmission request maximum sequence number (must be >= 0).

highSeqNum - High sequence number (must be >= 0).

sourceCbArg - Client callback object, set by LBMSourceCreationCallback.

source - The unique source name string (e.g., "TCP:192.168.0.4:45789").

Throws:

LBMEInvalException - if lowSeqNum, lowRxReqMaxSeqNum, or highSeqNum < 0.

Since:

UME 2.0

Method Detail

flags

public int flags()

Get recovery sequence number info informational flags.

Returns:

Informational flags.

Since:

UME 2.0

lowSequenceNumber

public long lowSequenceNumber()

Get low sequence number.

Returns:

Low sequence number.

Since:

UME 2.0

lowRxReqMaxSequenceNumber

public long lowRxReqMaxSequenceNumber()

Get low retransmission request maximum sequence number.

Returns:

low rxreq max sequence number.

Since:

UME 2.0

highSequenceNumber

public long highSequenceNumber()

Get high sequence number.

Returns:

High sequence number.

Since:

UME 2.0

sourceClientObject

public java.lang.Object sourceClientObject()

Get source callback object.

Returns:

Source callback object.

Since:

UME 2.0

source

public java.lang.String source()

Get source name string.

Returns:

Source name.

Since:

UME 2.0

setLowSequenceNumber

public void setLowSequenceNumber(long lowSeqNum)
                          throws LBMEInvalException

Set the desired starting low sequence number for recovery events. Used in UMERecoverySequenceNumberCallback callbacks.

Parameters:

lowSeqNum - Desired starting sequence number for recovery (must be >= 0).

Throws:

LBMEInvalException - if lowSeqNum < 0.

Since:

UME 2.0