com.latencybusters.lbm
Class LBMMonitorReceiver

java.lang.Object
  com.latencybusters.lbm.LBMMonitorReceiver

public class LBMMonitorReceiver
extends java.lang.Object

LBMMonitorReceiver class.

Constructor Summary

LBMMonitorReceiver(int formatter, java.lang.String formatOpts, int transport, java.lang.String transportOpts)
Create an LBM Monitoring Receiver Controller.

LBMMonitorReceiver(int formatter, java.lang.String formatOpts, int transport, java.lang.String transportOpts, LBMObjectRecyclerBase recycler, java.lang.Object objRecCbArg)
Create an LBM Monitoring Receiver Controller.

Method Summary

void	addStatisticsCallback(LBMMonitorStatisticsCallback cb) Deprecated. This method is provided for backwards compatibility with LBM 3.3.9/ UME 2.0.7; please use the addStatisticsCallback(LBMMonitorStatisticsCallbackObject) method instead.
void	addStatisticsCallback(LBMMonitorStatisticsCallbackObject cb) Register statistics callbacks.
void	close() Destroy a statistics receive controller.
protected void	finalize()
void	removeStatisticsCallback(LBMMonitorStatisticsCallback cb) Deprecated. This method is provided for backwards compatibility with LBM 3.3.9/ UME 2.0.7; please use the removeStatisticsCallback(LBMMonitorStatisticsCallbackObject) method instead.
void	removeStatisticsCallback(LBMMonitorStatisticsCallbackObject cb) Deregister previously registered statistics callback.

Methods inherited from class java.lang.Object

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

Constructor Detail

LBMMonitorReceiver

public LBMMonitorReceiver(int formatter,
                          java.lang.String formatOpts,
                          int transport,
                          java.lang.String transportOpts)
                   throws LBMException

Create an LBM Monitoring Receiver Controller. This creates an instance of an LBM Monitoring Receive Controller. On some JVMs this object may be garbage collected prematurely if it is not referenced after creation; therefore, it may be prudent to explicitly call its close method at a point in the program logic where it would no longer be required.

Parameters:

formatter - Format module type

formatOpts - A block of data which is passed to the format module's initialization function. This may be used to pass configuration options to the format module. `

transport - Transport module type

transportOpts - A block of data which is passed to the transport module's initialization function. This may be used to pass configuration options to the transport module.

Throws:

LBMException - if any error occurs creating the monitor receiver.

See Also:

close()

LBMMonitorReceiver

public LBMMonitorReceiver(int formatter,
                          java.lang.String formatOpts,
                          int transport,
                          java.lang.String transportOpts,
                          LBMObjectRecyclerBase recycler,
                          java.lang.Object objRecCbArg)
                   throws LBMException

Create an LBM Monitoring Receiver Controller. This creates an instance of an LBM Monitoring Receive Controller. On some JVMs this object may be garbage collected prematurely if it is not referenced after creation; therefore, it may be prudent to explicitly call its close method at a point in the program logic where it would no longer be required.

Parameters:

formatter - Format module type

formatOpts - A block of data which is passed to the format module's initialization function. This may be used to pass configuration options to the format module. `

transport - Transport module type

transportOpts - A block of data which is passed to the transport module's initialization function. This may be used to pass configuration options to the transport module.

recycler - an object recycler to handle recycling stats objects. Only the last callback should call the doneWith* method to return the stat object back to the recycler.

objRecCbArg - a callback object token that will be passed to the recycler (normally null is used)

Throws:

LBMException - if any error occurs creating the monitor receiver.

See Also:

close()

Method Detail

finalize

protected void finalize()
                 throws LBMException

Overrides:

finalize in class java.lang.Object

Throws:

LBMException

close

public void close()
           throws LBMException

Destroy a statistics receive controller. Destroys a monitoring controller.

Throws:

LBMException - if any error occurs destroying the monitor receiver.

addStatisticsCallback

public void addStatisticsCallback(LBMMonitorStatisticsCallback cb)

Deprecated. This method is provided for backwards compatibility with LBM 3.3.9/ UME 2.0.7; please use the addStatisticsCallback(LBMMonitorStatisticsCallbackObject) method instead.

Register statistics callbacks.

Parameters:

cb - Object implementing the LBMMonitorStatisticsCallback interface

removeStatisticsCallback

public void removeStatisticsCallback(LBMMonitorStatisticsCallback cb)

Deprecated. This method is provided for backwards compatibility with LBM 3.3.9/ UME 2.0.7; please use the removeStatisticsCallback(LBMMonitorStatisticsCallbackObject) method instead.

Deregister previously registered statistics callback.

Parameters:

cb - Previously registered object implementing the LBMMonitorStatisticsCallback interface

addStatisticsCallback

public void addStatisticsCallback(LBMMonitorStatisticsCallbackObject cb)

Register statistics callbacks.

Parameters:

cb - Object extending the LBMMonitorStatisticsCallbackObject class.

removeStatisticsCallback

public void removeStatisticsCallback(LBMMonitorStatisticsCallbackObject cb)

Deregister previously registered statistics callback.

Parameters:

cb - Previously registered object extending the LBMMonitorStatisticsCallbackObject class.