com.latencybusters.lbm
Class LBMHFXReceiver

java.lang.Object
  com.latencybusters.lbm.LBMHFXReceiver

public class LBMHFXReceiver
extends java.lang.Object

Method Summary

void	close() Close this receiver.
void	close(LBMOperationCompleteCallback cb, java.lang.Object cbArg) Close this receiver.
LBMConfigOption[]	dumpAttributeList() Returns an array of LBMConfigOptions
java.lang.String	getAttributeValue(java.lang.String attributeName) Returns the value of a receiver-related attribute for this receiver.
LBMReceiverStatistics	getStatistics(int maxStats) Return the current set of receiver transport statistics for all sources.
LBMReceiverStatistics	getStatistics(java.lang.String source) Return the current set of receiver transport statistics for a particular source.
int	setAttributeValue(java.lang.String attributeName, java.lang.String attributeValue) Set the value of a receiver-related attribute for this receiver.

Methods inherited from class java.lang.Object

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

Method Detail

dumpAttributeList

public LBMConfigOption[] dumpAttributeList()

Returns an array of LBMConfigOptions

Returns:

Array of LBMConfigOption

setAttributeValue

public int setAttributeValue(java.lang.String attributeName,
                             java.lang.String attributeValue)

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

Parameters:

attributeName - Name of the attribute to set

attributeValue - New attribute value

Throws:

LBMException - if attributeName is not a valid attribute, or attributeValue is not a valid value for attributeName.

getAttributeValue

public java.lang.String getAttributeValue(java.lang.String attributeName)

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

Parameters:

attributeName - Name of the attribute to retrieve

Returns:

Value corresponding to the specified attribute name

Throws:

LBMException - if attributeName is not a valid attribute.

getStatistics

public LBMReceiverStatistics getStatistics(java.lang.String source)
                                    throws LBMException

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

Parameters:

source - Source 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.

Throws:

LBMException - if any error occurred retrieving receiver statistics.

getStatistics

public LBMReceiverStatistics getStatistics(int maxStats)
                                    throws LBMException

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

Parameters:

maxStats - Maximum number of sources

Returns:

LBMReceiverStatistics object containing the statistics corresponding to the specified number of sources

Throws:

LBMException - if any error occurred retrieving receiver statistics.

close

public void close()

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

close

public void close(LBMOperationCompleteCallback cb,
                  java.lang.Object cbArg)

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

Parameters:

cb - Callback to be invoked when the close operation is complete.

cbArg - Token to be delivered with the callback.