com.latencybusters.lbm
Class LBMHFX

java.lang.Object
  com.latencybusters.lbm.LBMHFX

public class LBMHFX
extends java.lang.Object

Constructor Summary

	LBMHFX(LBMHFXAttributes attr, java.lang.String topic, LBMReceiverCallback cb, LBMEventQueue evq) Instantiate a new LBMHFX object on the specified topic.
protected	LBMHFX(java.lang.String topic)

Method Summary

void	close() Close this HFX object.
void	close(LBMOperationCompleteCallback cb, java.lang.Object cbArg) Close this HFX object.
LBMHFXReceiver	createReceiver(LBMContext ctx, LBMReceiverAttributes rattr, java.lang.Object cbArg) Create a receiver on the specified context, with the specified attributes and callback token.
LBMConfigOption[]	dumpAttributeList() Returns an array of LBMConfigOptions
java.lang.String	getAttributeValue(java.lang.String attributeName) Returns the value of a HFX-related attribute for this HFX.
protected int	onReceive(java.lang.Object cbArg, LBMMessage msg) Internal callback used when a message is delivered.
void	setAttributeValue(java.lang.String attributeName, java.lang.String attributeValue) Set the value of a HFX-related attribute for this HFX.

Methods inherited from class java.lang.Object

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

Constructor Detail

LBMHFX

protected LBMHFX(java.lang.String topic)

LBMHFX

public LBMHFX(LBMHFXAttributes attr,
              java.lang.String topic,
              LBMReceiverCallback cb,
              LBMEventQueue evq)

Instantiate a new LBMHFX object on the specified topic. This constructor will create a new LBMHFX object.

Parameters:

attr - Optional attributes that modify the behavior of the LBMHFX object.

topic - The topic to be used for all receivers created using this LBMHFX object.

cb - The callback to be invoked when a new message is delivered.

evq - Optional event queue to be used to deliver messages.

Method Detail

dumpAttributeList

public LBMConfigOption[] dumpAttributeList()

Returns an array of LBMConfigOptions

Returns:

Array of LBMConfigOption

close

public void close()

Close this HFX object. All receivers created using the HFX.createReceiver method should be closed before attempting to close the HFX object. 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 HFX object. All receivers created using the HFX.createReceiver method should be closed before attempting to close the HFX object. Warning: It is not safe to call this method from a context thread callback.

Parameters:

cb - Callback to be called when the object is completely closed.

cbArg - Token to be delivered with the callback.

onReceive

protected int onReceive(java.lang.Object cbArg,
                        LBMMessage msg)

Internal callback used when a message is delivered.

createReceiver

public LBMHFXReceiver createReceiver(LBMContext ctx,
                                     LBMReceiverAttributes rattr,
                                     java.lang.Object cbArg)

Create a receiver on the specified context, with the specified attributes and callback token. A hot failover receiver is created on the specified context with the attributes passed in. Some attributes related to message delivery may be overridden (e.g. duplicate delivery will be enabled if it is enabled on the HFX object.

Parameters:

ctx - Context on which to create the receiver.

rattr - Attributes to be used for the receiver.

cbArg - Callback token to be associated with messages delivered through the newly created receiver.

getAttributeValue

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

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

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.

setAttributeValue

public void setAttributeValue(java.lang.String attributeName,
                              java.lang.String attributeValue)
                       throws LBMException

Set the value of a HFX-related attribute for this HFX. Note that this method bypasses the property list. As such no attributes configured using this method will appear in the property list.

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.

See Also:

#setProperty