UM Java API  6.16.1
com.latencybusters.lbm.LBMHFXReceiver Class Reference

Public Member Functions

LBMConfigOption[] dumpAttributeList ()
 
int setAttributeValue (String attributeName, String attributeValue)
 
String getAttributeValue (String attributeName)
 
LBMReceiverStatistics getStatistics (String source) throws LBMException
 
LBMReceiverStatistics getStatistics (int maxStats) throws LBMException
 
void close ()
 
void close (LBMOperationCompleteCallback cb, Object cbArg)
 

Member Function Documentation

void com.latencybusters.lbm.LBMHFXReceiver.close ( )

Close this receiver. Warning: It is not safe to call this method from a context thread callback.

void com.latencybusters.lbm.LBMHFXReceiver.close ( LBMOperationCompleteCallback  cb,
Object  cbArg 
)

Close this receiver. Warning: It is not safe to call this method from a context thread callback.

Parameters
cbCallback to be invoked when the close operation is complete.
cbArgToken to be delivered with the callback.
LBMConfigOption [] com.latencybusters.lbm.LBMHFXReceiver.dumpAttributeList ( )

Returns an array of LBMConfigOptions

Returns
Array of LBMConfigOption
String com.latencybusters.lbm.LBMHFXReceiver.getAttributeValue ( String  attributeName)

Returns the value of a receiver-related attribute for this receiver.

Parameters
attributeNameName of the attribute to retrieve
Returns
Value corresponding to the specified attribute name
Exceptions
LBMExceptionif attributeName is not a valid attribute.
LBMReceiverStatistics com.latencybusters.lbm.LBMHFXReceiver.getStatistics ( String  source) throws LBMException

Return the current set of receiver transport statistics for a particular source.

Parameters
sourceSource string (as returned by LBMMesage source()) that specifies the set of statistics to return.
Returns
LBMReceiverStatistics object containing the statistics corresponding to the specified source.
Exceptions
LBMExceptionif any error occurred retrieving receiver statistics.

References com.latencybusters.lbm.LBMReceiverStatistics.refresh(), and com.latencybusters.lbm.LBMObjectRecyclerBase.retrieveReceiverStatistics().

LBMReceiverStatistics com.latencybusters.lbm.LBMHFXReceiver.getStatistics ( int  maxStats) throws LBMException

Return the current set of receiver transport statistics for all sources.

Parameters
maxStatsMaximum number of sources
Returns
LBMReceiverStatistics object containing the statistics corresponding to the specified number of sources
Exceptions
LBMExceptionif any error occurred retrieving receiver statistics.

References com.latencybusters.lbm.LBMReceiverStatistics.refresh(), and com.latencybusters.lbm.LBMObjectRecyclerBase.retrieveReceiverStatistics().

int com.latencybusters.lbm.LBMHFXReceiver.setAttributeValue ( String  attributeName,
String  attributeValue 
)

Set the value of a receiver-related attribute for this receiver.

Parameters
attributeNameName of the attribute to set
attributeValueNew attribute value
Exceptions
LBMExceptionif attributeName is not a valid attribute, or attributeValue is not a valid value for attributeName.

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