UM .NET API  6.16.1
com.latencybusters.lbm.UMESourceEventDeregistrationSuccessInfo Class Reference

UME Source Event Deregistration Success Info class. More...

Public Member Functions

 UMESourceEventDeregistrationSuccessInfo ()
 Creates a UMESourceEventDeregistrationSuccessInfo object and initializes all fields to 0/null.
 
 UMESourceEventDeregistrationSuccessInfo (int flags, uint registrationId, uint sequenceNumber, ushort storeIndex, string store)
 Creates a UMESourceEventDeregistrationSuccessInfo object and initializes fields to the given values. More...
 
int flags ()
 Returns store registration type flags. More...
 
uint registrationId ()
 Returns the source's registration ID. More...
 
uint sequenceNumber ()
 Returns the source's starting sequence number. More...
 
ushort storeIndex ()
 Returns the index of the store this source successfully registered to. More...
 
string store ()
 Returns the name (IP address) of the store registered with. More...
 

Detailed Description

UME Source Event Deregistration Success Info class.

Retrieved with the LBMSourceEvent.deregistrationSuccessInfo() method. Contains extended deregistration success info.

Constructor & Destructor Documentation

com.latencybusters.lbm.UMESourceEventDeregistrationSuccessInfo.UMESourceEventDeregistrationSuccessInfo ( int  flags,
uint  registrationId,
uint  sequenceNumber,
ushort  storeIndex,
string  store 
)

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

Parameters
flagsInformational flags concerning the type of store deregistration.
registrationIdThe source's registration ID with this store (must be >= 0).
sequenceNumberStarting sequence number.
storeIndexIndex of the store (must be >= 0).
storeName of the store.
Exceptions
com.latencybusters.lbm.LBMEInvalExceptionUME source registration ID was < 0.
com.latencybusters.lbm.LBMEInvalExceptionUME sequence number was < 0.
com.latencybusters.lbm.LBMEInvalExceptionUME store index was < 0.

Member Function Documentation

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

Returns store registration type flags.

Returns
Informational flags about the source's registration.
uint com.latencybusters.lbm.UMESourceEventDeregistrationSuccessInfo.registrationId ( )

Returns the source's registration ID.

Returns
Source's registration ID with this store.
uint com.latencybusters.lbm.UMESourceEventDeregistrationSuccessInfo.sequenceNumber ( )

Returns the source's starting sequence number.

Returns
Source's starting sequence number.
string com.latencybusters.lbm.UMESourceEventDeregistrationSuccessInfo.store ( )

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

Returns
Name of the store.

References com.latencybusters.lbm.LBM.UME_MAX_STORE_STRLEN.

ushort com.latencybusters.lbm.UMESourceEventDeregistrationSuccessInfo.storeIndex ( )

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

Returns
Index of the store.

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