UM .NET API  6.16
com.latencybusters.lbm.UMEDeregistrationSuccessInfo Class Reference

UME Deregistration Success Info class. More...

Public Member Functions

 UMEDeregistrationSuccessInfo ()
 Creates a UMEDeregistrationSuccessInfo object and initializes all fields to 0/null.
 
 UMEDeregistrationSuccessInfo (int flags, uint sourceRegId, uint receiverRegId, uint sequenceNumber, ushort storeIndex, string store)
 Creates a UMEDeregistrationSuccessInfo object and initializes fields to supplied values. More...
 
int flags ()
 Get deregistration success flags. More...
 
uint sourceRegistrationId ()
 Get source registration ID. More...
 
uint receiverRegistrationId ()
 Get receiver registration ID. More...
 
uint sequenceNumber ()
 Get starting sequence number. More...
 
ushort storeIndex ()
 Get index of the store successfully registered with. More...
 
string store ()
 Get name (IP address) of the store successfully registered with. More...
 

Detailed Description

UME Deregistration Success Info class.

Contains extended information for UME deregistration success messages, like flags indicating any conditions on store deregistration, source and receiver registration IDs, and the store's name and group index.

Constructor & Destructor Documentation

com.latencybusters.lbm.UMEDeregistrationSuccessInfo.UMEDeregistrationSuccessInfo ( int  flags,
uint  sourceRegId,
uint  receiverRegId,
uint  sequenceNumber,
ushort  storeIndex,
string  store 
)

Creates a UMEDeregistrationSuccessInfo object and initializes fields to supplied values.

Parameters
flagsFlags concerning the type of deregistration.
sourceRegIdSource registration ID (must be >= 0).
receiverRegIdReceiver registration ID (must be >= 0).
sequenceNumberStarting sequence number.
storeIndexIndex of store registered with (must be >= 0).
storeName (IP address) of store registered with.
Exceptions
com.latencybusters.lbm.LBMEInvalExceptionUME source registration ID was < 0.
com.latencybusters.lbm.LBMEInvalExceptionUME receiver 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.UMEDeregistrationSuccessInfo.flags ( )

Get deregistration success flags.

Returns
Flags.
uint com.latencybusters.lbm.UMEDeregistrationSuccessInfo.receiverRegistrationId ( )

Get receiver registration ID.

Returns
Receiver registration ID.
uint com.latencybusters.lbm.UMEDeregistrationSuccessInfo.sequenceNumber ( )

Get starting sequence number.

Returns
Starting sequence number.
uint com.latencybusters.lbm.UMEDeregistrationSuccessInfo.sourceRegistrationId ( )

Get source registration ID.

Returns
Source registration ID.
string com.latencybusters.lbm.UMEDeregistrationSuccessInfo.store ( )

Get name (IP address) of the store successfully registered with.

Returns
Name (IP address) of the store.
ushort com.latencybusters.lbm.UMEDeregistrationSuccessInfo.storeIndex ( )

Get index of the store successfully registered with.

Returns
Index of the store.

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