UM Java API  6.16
com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo Class Reference

Public Member Functions

 UMESourceEventRegistrationSuccessInfo ()
 
 UMESourceEventRegistrationSuccessInfo (int flags, long registrationId, long sequenceNumber, int storeIndex, String store) throws LBMEInvalException
 
int flags ()
 
long registrationId ()
 
long sequenceNumber ()
 
int storeIndex ()
 
String store ()
 

Detailed Description

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

Since
UME 2.0

Constructor & Destructor Documentation

com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.UMESourceEventRegistrationSuccessInfo ( )

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

Since
UME 2.0
com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.UMESourceEventRegistrationSuccessInfo ( int  flags,
long  registrationId,
long  sequenceNumber,
int  storeIndex,
String  store 
) throws LBMEInvalException

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

Parameters
flagsInformational flags concerning the type of store registration.
registrationIdThe source's registration ID with this store (must be >= 0).
storeIndexIndex of the store (must be >= 0).
storeName of the store.
sequenceNumberThe sequence number to start at, according to the store.
Exceptions
LBMEInvalExceptionif registrationId or storeIndex are < 0.
Since
UME 2.0

References com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.flags(), com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.registrationId(), com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.sequenceNumber(), com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.store(), and com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.storeIndex().

Member Function Documentation

int com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.flags ( )

Returns store registration type flags.

Returns
Informational flags about the source's registration.
Since
UME 2.0

Referenced by com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.store(), and com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.UMESourceEventRegistrationSuccessInfo().

long com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.registrationId ( )

Returns the source's registration ID.

Returns
Source's registration ID with this store.
Since
UME 2.0

Referenced by com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.store(), and com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.UMESourceEventRegistrationSuccessInfo().

long com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.sequenceNumber ( )

Returns source's starting sequence number.

Returns
Source's starting sequence number.
Since
UME 2.0

Referenced by com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.store(), and com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.UMESourceEventRegistrationSuccessInfo().

int com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.storeIndex ( )

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

Returns
Index of the store.
Since
UME 2.0

Referenced by com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.store(), and com.latencybusters.lbm.UMESourceEventRegistrationSuccessInfo.UMESourceEventRegistrationSuccessInfo().


The documentation for this class was generated from the following file: