com.latencybusters.lbm
Class UMESourceEventRegistrationSuccessInfo

java.lang.Object
  com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo

public class UMESourceEventRegistrationSuccessInfo
extends java.lang.Object

UME Source Event Registration Success Info class. Retrieved with the LBMSourceEvent.registrationSuccessInfo() method. Contains extended registration success info.

Since:

UME 2.0

Constructor Summary

UMESourceEventRegistrationSuccessInfo()
Creates a UMESourceEventRegistrationSuccessInfo object and initializes all fields to 0/null.

UMESourceEventRegistrationSuccessInfo(int flags, long registrationId, long sequenceNumber, int storeIndex, java.lang.String store)
Creates a UMESourceEventRegistrationSuccessInfo object and initializes fields to the given values.

Method Summary

int	flags() Returns store registration type flags.
long	registrationId() Returns the source's registration ID.
long	sequenceNumber() Returns source's starting sequence number.
java.lang.String	store() Returns the name (IP address) of the store registered with.
int	storeIndex() Returns the index of the store this source successfully registered to.

Methods inherited from class java.lang.Object

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

Constructor Detail

UMESourceEventRegistrationSuccessInfo

public UMESourceEventRegistrationSuccessInfo()

Creates a UMESourceEventRegistrationSuccessInfo object and initializes all fields to 0/null.

Since:

UME 2.0

UMESourceEventRegistrationSuccessInfo

public UMESourceEventRegistrationSuccessInfo(int flags,
                                             long registrationId,
                                             long sequenceNumber,
                                             int storeIndex,
                                             java.lang.String store)
                                      throws LBMEInvalException

Creates a UMESourceEventRegistrationSuccessInfo object and initializes fields to the given values.

Parameters:

flags - Informational flags concerning the type of store registration.

registrationId - The source's registration ID with this store (must be >= 0).

storeIndex - Index of the store (must be >= 0).

store - Name of the store.

sequenceNumber - The sequence number to start at, according to the store.

Throws:

LBMEInvalException - if registrationId or storeIndex are < 0.

Since:

UME 2.0

Method Detail

flags

public int flags()

Returns store registration type flags.

Returns:

Informational flags about the source's registration.

Since:

UME 2.0

registrationId

public long registrationId()

Returns the source's registration ID.

Returns:

Source's registration ID with this store.

Since:

UME 2.0

sequenceNumber

public long sequenceNumber()

Returns source's starting sequence number.

Returns:

Source's starting sequence number.

Since:

UME 2.0

storeIndex

public int storeIndex()

Returns the index of the store this source successfully registered to.

Returns:

Index of the store.

Since:

UME 2.0

store

public java.lang.String store()

Returns the name (IP address) of the store registered with.

Returns:

Name of the store.

Since:

UME 2.0