Inheritance diagram for com.latencybusters.lbm.LBMObjectRecycler:

Public Member Functions
void	setLocalMsgPoolSize (int size)

void	setSharedMsgPoolSize (int size)

void	doneWithMessage (LBMMessage obj)

LBMMessage	retrieveMessage (Object cbObj)

int	getLocalPoolMessageCount ()

int	returnAllMessagesToSharedPool ()

void	setLocalRcvStatsPoolSize (int size)

void	setSharedRcvStatsPoolSize (int size)

void	doneWithReceiverStatistics (LBMReceiverStatistics obj)

LBMReceiverStatistics	retrieveReceiverStatistics (Object cbObj)

int	getLocalPoolReceiverStatisticsCount ()

int	returnAllReceiverStatisticsToSharedPool ()

void	setLocalSrcStatsPoolSize (int size)

void	setSharedSrcStatsPoolSize (int size)

void	doneWithSourceStatistics (LBMSourceStatistics obj)

LBMSourceStatistics	retrieveSourceStatistics (Object cbObj)

int	getLocalPoolSourceStatisticsCount ()

int	returnAllSourceStatisticsToSharedPool ()

void	setLocalCtxStatsPoolSize (int size)

void	setSharedCtxStatsPoolSize (int size)

void	doneWithContextStatistics (LBMContextStatistics obj)

LBMContextStatistics	retrieveContextStatistics (Object cbObj)

int	getLocalPoolContextStatisticsCount ()

int	returnAllContextStatisticsToSharedPool ()

void	setLocalIMRcvStatsPoolSize (int size)

void	setSharedIMRcvStatsPoolSize (int size)

void	doneWithImmediateMessageReceiverStatistics (LBMImmediateMessageReceiverStatistics obj)

LBMImmediateMessageReceiverStatistics	retrieveImmediateMessageReceiverStatistics (Object cbObj)

int	getLocalPoolImmediateMessageReceiverStatisticsCount ()

int	returnAllImmediateMessageReceiverStatisticsToSharedPool ()

void	setLocalIMSrcStatsPoolSize (int size)

void	setSharedIMSrcStatsPoolSize (int size)

void	doneWithImmediateMessageSourceStatistics (LBMImmediateMessageSourceStatistics obj)

LBMImmediateMessageSourceStatistics	retrieveImmediateMessageSourceStatistics (Object cbObj)

int	getLocalPoolImmediateMessageSourceStatisticsCount ()

int	returnAllImmediateMessageSourceStatisticsToSharedPool ()

void	setLocalEvqStatsPoolSize (int size)

void	setSharedEvqStatsPoolSize (int size)

void	doneWithEventQueueStatistics (LBMEventQueueStatistics obj)

LBMEventQueueStatistics	retrieveEventQueueStatistics (Object cbObj)

int	getLocalPoolEventQueueStatisticsCount ()

int	returnAllEventQueueStatisticsToSharedPool ()

void	setLocalSrcEvPoolSize (int size)

void	setSharedSrcEvPoolSize (int size)

void	doneWithSourceEvent (LBMSourceEvent obj)

LBMSourceEvent	retrieveSourceEvent (Object cbObj)

int	getLocalPoolSourceEventCount ()

int	returnAllSourceEventsToSharedPool ()

void	setLocalCtxSrcEvPoolSize (int size)

void	setSharedCtxSrcEvPoolSize (int size)

void	doneWithContextSourceEvent (LBMContextSourceEvent obj)

LBMContextSourceEvent	retrieveContextSourceEvent (Object cbObj)

int	getLocalPoolContextSourceEventCount ()

int	returnAllContextSourceEventsToSharedPool ()

void	setLocalAsyncOpInfosPoolSize (int size)

void	setSharedAsyncOpInfosPoolSize (int size)

void	doneWithAsyncOperationInfo (LBMAsyncOperationInfo obj)

LBMAsyncOperationInfo	retrieveAsyncOperationInfo (Object cbObj)

int	getLocalPoolAsyncOperationInfoCount ()

int	returnAllAsyncOperationInfosToSharedPool ()

void	disposeThreadLocals ()

void	close ()

void	doneWithContextSourceEvent (LBMSourceEvent obj)

Detailed Description

Basic implementation of an object recycler that implements all supported LBM object types. The size limits for the object pools for each object type can be tuned and should be set immediately after instantiating the class and before using any instance of the class. This implementation is synchronized on a per object type basis(doneWithMessage/retrieveMessage, doneWithReceiverStatistics/retrieveReceiverStatistics, etc) via a thread local pool of objects and a synchronized shared pool of objects.

Member Function Documentation

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

A method to clean up all objects referenced by the recycler when the application is closing (which will dispose all of the stats objects in the recycler).

References com.latencybusters.lbm.LBMContextStatistics.dispose(), com.latencybusters.lbm.LBMImmediateMessageSourceStatistics.dispose(), com.latencybusters.lbm.LBMImmediateMessageReceiverStatistics.dispose(), com.latencybusters.lbm.LBMEventQueueStatistics.dispose(), com.latencybusters.lbm.LBMSourceStatistics.dispose(), and com.latencybusters.lbm.LBMReceiverStatistics.dispose().

void com.latencybusters.lbm.LBMObjectRecycler.disposeThreadLocals ( )

A convenience method to clean up thread local variables if needed.

void com.latencybusters.lbm.LBMObjectRecycler.doneWithAsyncOperationInfo ( LBMAsyncOperationInfo obj )

Call when finished with a LBMAsyncOperationInfo object. Do not call dispose on the async info object before passing to this method. If the local and shared object limit is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The async info object

void com.latencybusters.lbm.LBMObjectRecyclerBase.doneWithContextSourceEvent ( LBMSourceEvent obj )

inherited

If dispose is not called on an LBMContextSourceEvent in the callback, it is retained for use in the application. Once the application is finished with the LBMContextSourceEvent, it should call dispose and then pass it to this method to make it available for reuse, instead of letting it be garbage collected.

Parameters

obj	The LBMContextSourceEvent object that the application is done with and is ready for reuse

void com.latencybusters.lbm.LBMObjectRecycler.doneWithContextSourceEvent ( LBMContextSourceEvent obj )

Call when finished with a LBMContextSourceEvent object. Call dispose on the source event object before passing to this method. If the local and shared object size is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The message object

void com.latencybusters.lbm.LBMObjectRecycler.doneWithContextStatistics ( LBMContextStatistics obj )

Call when finished with a LBMContextStatistics object. Do not call dispose on the stats object before passing to this method. If the local and shared object size is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The stats object

void com.latencybusters.lbm.LBMObjectRecycler.doneWithEventQueueStatistics ( LBMEventQueueStatistics obj )

Call when finished with a LBMEventQueueStatistics object. Do not call dispose on the stats object before passing to this method. If the local and shared object limit is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The stats object

void com.latencybusters.lbm.LBMObjectRecycler.doneWithImmediateMessageReceiverStatistics ( LBMImmediateMessageReceiverStatistics obj )

Call when finished with a LBMImmediateMessageReceiverStatistics object. Do not call dispose on the stats object before passing to this method. If the local and shared object limit is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The stats object

void com.latencybusters.lbm.LBMObjectRecycler.doneWithImmediateMessageSourceStatistics ( LBMImmediateMessageSourceStatistics obj )

Call when finished with a LBMImmediateMessageSourceStatistics object. Do not call dispose on the stats object before passing to this method. If the local and shared object limit is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The stats object

void com.latencybusters.lbm.LBMObjectRecycler.doneWithMessage ( LBMMessage obj )

Call when finished with a LBMMessage object. Call dispose on the message object before passing to this method. If the local and shared object size is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The message object

void com.latencybusters.lbm.LBMObjectRecycler.doneWithReceiverStatistics ( LBMReceiverStatistics obj )

Call when finished with a LBMReceiverStatistics object. Do not call dispose on the stats object before passing to this method. If the local and shared object limit is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The stats object

void com.latencybusters.lbm.LBMObjectRecycler.doneWithSourceEvent ( LBMSourceEvent obj )

Call when finished with a LBMSourceEvent object. Call dispose on the source event object before passing to this method. If the local and shared object size is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The message object

void com.latencybusters.lbm.LBMObjectRecycler.doneWithSourceStatistics ( LBMSourceStatistics obj )

Call when finished with a LBMSourceStatistics object. Do not call dispose on the stats object before passing to this method. If the local and shared object limit is reached, it will simply ignore the passed object which will result in it being garbage collected.

Parameters

obj	The stats object

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolAsyncOperationInfoCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolContextSourceEventCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolContextStatisticsCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolEventQueueStatisticsCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolImmediateMessageReceiverStatisticsCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolImmediateMessageSourceStatisticsCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolMessageCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolReceiverStatisticsCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolSourceEventCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

int com.latencybusters.lbm.LBMObjectRecycler.getLocalPoolSourceStatisticsCount ( )

Gets the current number of objects in the local pool.

Returns: The number of objects

LBMAsyncOperationInfo com.latencybusters.lbm.LBMObjectRecycler.retrieveAsyncOperationInfo ( Object cbObj )

LBM will call this method to attempt to retrieve an object that it can reuse. It will transfer a batch of objects from the shared pool when the local pool gets low or will create the objects if the shared pool is empty.

Parameters