LBM .Net API Documentation
com.latencybusters.lbm Namespace
Namespacescom.latencybusters.lbm
LBM Classes
Declaration Syntax
C#
namespace com.latencybusters.lbm
Types
All TypesClassesStructuresDelegates
IconTypeDescription
JMSMessageId
JMSMessageID class. This object creates a JMSMessageId.

LBM
LBM Utility class.

LBMConfigOption
LBM Option class

LBMContext
Creates an LBM context.

LBMContextAttributes
Encapsulates the set of default LBM context attributes.

LBMContextEvent
Encapsulates LBM Context Events

LBMContextEventCallback
Context event callback.

LBMContextSourceEvent
Encapsulates an LBM context-level source event.

LBMContextSourceEventCallback
Context source event callback delegate

LBMContextStatistics
LBM Context Statistics

LBMEInvalException
LBM Invalid value exception class

LBMEMessageSelectorException
LBM message selector exception class

LBMENoMemException
LBM memory allocation exception class

LBMEOPException
LBM internal processing exception class

LBMEOSException
LBM unrecoverable OS system call exception class

LBMETimedOutException
LBM timed out operation exception class

LBMEventQueue
LBM Event Queue class. This class may be subclassed to override the default event queue monitoring method or an LBMEventQueueCallback interface may be specified to handle the monitor callback.

LBMEventQueueAttributes
Encapsulates the set of default LBM event queue attributes

LBMEventQueueCallback
Event queue callback delegate

LBMEventQueueStatistics
UM event queue statistics. These are statistics for messages and other events that enter and exit the event queue. NOTE: Specific count-enable options must sometimes be enabled for these statistics to populate.

LBMEWouldBlockException
LBM blocked operation exception class (occurs when a function that would otherwise block is set to be nonblocking)

LBMException
Base LBM Exception class

LBMHFX
Creates an LBM HFX object.

LBMHFXAttributes
Encapsulates the set of default LBM HFX attributes

LBMHFXReceiver
The LBMHFXReceiver object is used to associate an LBMHFX object with an LBMContext. Messages are delivered by each LBMHFXReceiver to the LBMHFX object, which handles dropping duplicates and ordering messages.

LBMHotFailoverReceiver
LBM Hot-Failover Receiver class.

LBMHotFailoverSource
LBM Hot-Failover Source class.

LBMImmediateMessageCallback
Received immediate message callback delegate.

LBMImmediateMessageReceiverStatistics
UM Receiver Transport Statistics

LBMImmediateMessageSourceStatistics
UM context immediate message source transport statistics.

LBMLogging
LBM logging callback delegate

LBMMessage

Encapsulates all LBM messages.

Call dispose() to utilize Zero Object Delivery (ZOD), or promote() to retain message object after callback. You must call either one or the other.

When using ZOD (Zero Object Delivery), access message data via dataPointer() and length(). (For more information on ZOD, see Zero Object Delivery (ZOD) and Java API Overview.)

For object-based delivery (non-ZOD), access message data with data(), which creates a byte array object that contains the message data.


LBMMessageChannelInfo
Encapsulates information about channel data send with a message

LBMMessageProperties
Represents a collection of properties contained in an LBMMessage object.

LBMMessageProperty
Represents a key-value pair included with an LBMMessage object.

LBMMessageReclamationCallback
Forced message reclamation callback delegate (UME only).

LBMMonitor
LBM Monitor class

LBMMonitorContextStatisticsCallback
Received context statistics callback delegate

LBMMonitorEAgainException
LBM Monitor insufficient resources exception class

LBMMonitorEAlreadyException
LBM Monitor resource already registered exception class

LBMMonitorEInvalException
LBM Monitor invalid value exception class

LBMMonitorELBMFailException
LBM Monitor LBM failure exception class

LBMMonitorEModFailException
LBM Monitor module function failure exception class

LBMMonitorENoMemException
LBM Monitor out-of-memory exception class

LBMMonitorEventQueueStatisticsCallback
Received event queue statistics callback delegate

LBMMonitorImmediateMessageReceiverStatisticsCallback
Received immediate message receiver statistics callback delegate.

LBMMonitorImmediateMessageSourceStatisticsCallback
Received immediate message source statistics callback delegate.

LBMMonitorReceiver
LBM Monitor Receiver class.

LBMMonitorReceiverStatisticsCallback
Received receiver statistics callback delegate

LBMMonitorSource
LBM Monitor Source class.

LBMMonitorSourceStatisticsCallback
Received source statistics callback delegate

LBMObjectRecycler
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.

LBMObjectRecyclerBase

This is an abstract base class, and should be subclassed to override any appropriate non-functional methods, such as doneWith... or retrieve... (whose default implementation in the base class is to always return null). LBMObjectRecycler is provided as a basic general implementation of this class.

After being set in any of the UM attribute classes with the setObjectRecycler() method, UM uses the LBMObjectRecyclerBase internally, instead of automatically creating a new Object of the different supported types.

UM calls the appropriate retrieve method expecting either an object that it can use, or null. In the latter case UM creates the new object as if there were no recycler available. Once finished with an object, calling the appropriate doneWith method makes it available for future retrieve calls.

When implementing your own recycler from this parent class, note that the retrieve methods (below) are called from within the context thread as part of the callbacks. Hence, do not perform any unsafe API calls from within a retrieve method.


LBMOperationCompleteCallback..::.LBMOperationComplete
Operation Complete delegate. A method matching this delegate may be passed to the LBMOperationCompleteCallback constructor if a simple callback is desired when an operation is complete.

LBMOperationCompleteCallback
LBMOperationCompleteCallback class.

LBMReceiver
LBM Receiver class.

LBMReceiverAttributes
Encapsulates the set of default LBM receiver attributes

LBMReceiverCallback
Received message callback delegate

LBMReceiverCreationCallback
Application callback for notification of creation of a receiver for a topic.

LBMReceiverStatistics
LBM Receiver Transport Statistics

LBMRegistrationIdCallback
Receiver registration ID callback delegate (UME only)

LBMRequest
LBM Request class

LBMResponseCallback
Request response callback delegate

LBMSetInflightCallback
Callback for setting the inflight messages for a source.

LBMSetInflightCallbackEx
Callback for setting the number of inflight messages and bytes for a source simultaneously.

LBMSource
LBM Source class.

LBMSourceAttributes
Encapsulates the set of default LBM source attributes

LBMSourceChannelInfo
LBM Source Channel Info class.

LBMSourceCostCallback
Application callback to evaluate the cost of a newly discovered source. Set via the context attributes setSourceCostCallback function.

LBMSourceCreationCallback
Application callback for notification of creation of sources for a topic.

LBMSourceDeletionCallback
Application callback for notification of deletion of sources for a topic.

LBMSourceEvent
Encapsulates LBM Source Events.

LBMSourceEventCallback
Source event callback delegate

LBMSourceEventFlightSizeNotification
LBM Source Event Flight Size Notification class. Contains type and state of current flight size

LBMSourceEventSequenceNumberInfo
LBM Source Event Sequence Number Info class.

LBMSourceEventWakeupInfo
Class containing information about a source wakeup event.

LBMSourceNotification
New source notification callback delegate

LBMSourceSendExInfo
LBM Source Send Extended Info class.

LBMSourceStatistics
LBM Source Transport Statistics

LBMStatistics
UM Transport Statistics base class

LBMTimer
LBM Timer class

LBMTimerCallback
LBM Timer callback delegate

LBMTopic
LBM Topic class. It is recommended that topic objects be instantiated from the context factory methods allocTopic() and lookupTopic() (for sources and receivers respectively).

LBMTransportSourceInfo
Class that is passed to the source cost callback with source transport information.

LBMUMMInfo
LBM UMM options class.

LBMWildcardPatternCallback
LBM wildcard pattern match callback delegate

LBMWildcardReceiver
LBM Wildcard Receiver class

LBMWildcardReceiverAttributes
Encapsulates the set of default LBM wildcard receiver attributes

LBMWildcardReceiverCreateCallback
LBM wildcard receiver create callback delegate

LBMWildcardReceiverDeleteCallback
LBM wildcard receiver delete callback delegate

UMEDeregistrationCompleteInfo
UME Deregistration Complete Info class.

UMEDeregistrationSuccessInfo
UME Deregistration Success Info class.

UMEMessageAck
UMEMessageAck class. Use this object to send explicit acks.

UMENoQueueException
UME registration incomplete exception class

UMENoRegException
UME registration incomplete exception class

UMENoStoreException
UME registration incomplete exception class

UMEReceiverLivenessCallbackInfo
Class that is passed to the receiver liveness creation and deletion callback with receiver information.

UMEReceiverLivenessCreationCallback
Application callback to attain information about a new "connected" receiver.

UMEReceiverLivenessDeletionCallback
Application callback to attain information about a previously "connected" receiver that has gone away.

UMERecoverySequenceNumberCallback
Receiver recovery sequence number callback delegate

UMERecoverySequenceNumberCallbackInfo
UME Recovery sequence number callback info class.

UMERegistrationCompleteInfo
UME Registration Complete Info class.

UMERegistrationIdExCallback
Receiver registration ID callback delegate, extended version (UME only)

UMERegistrationIdExCallbackInfo
UME Registration ID Extended Callback Info class.

UMERegistrationSuccessInfo
UME Registration Success Info class.

UMESourceEventAckInfo
UME Source Event Ack Info class.

UMESourceEventDeregistrationCompleteInfo
UME Source Event Deregistration Complete Info class.

UMESourceEventDeregistrationSuccessInfo
UME Source Event Deregistration Success Info class.

UMESourceEventRegistrationCompleteInfo
UME Source Event Registration Complete Info class.

UMESourceEventRegistrationSuccessInfo
UME Source Event Registration Success Info class.

UMEStoreEntry
UME Store Entry class.

UMEStoreGroupEntry
UME Store Group Entry class.

UMQContextEventRegistrationCompleteInfo
Class containing information about UMQ Registration Complete Context Events. This info object is delivered with a UMQ Registration Complete Context Event, containing information identifying the queue and registration id associated with the registration complete event.

UMQContextEventRegistrationSuccessInfo
Class containing information about UMQ Registration Success Context Events. This info object is delivered with a UMQ Registration Success Context Event, containing information identifying the queue, queue instance, and registration id associated with the registration success event.

UMQDeregistrationCompleteInfo
UMQ Deregistration Complete Info class. Contains extended information for UMQ receiver deregistration complete messages. This info object is supplied with a message indicating the a receiver has successfully deregistered with a queue.

UMQIndexAssignedInfo
Class containing information about UMQ index assignment events. This info object is delivered with a UMQ Index Assigned receiver event, containing information identifying the queue, queue instance, and index information associated with the index assigned event.

UMQIndexAssignmentEligibilityStartCompleteInfo
UMQ Index Assignment Eligibility Start Complete Info class. Contains extended information for UMQ receiver index assignment eligibility start complete messages. This info object is supplied with a message indicating the a receiver is now eligible for new index assignments from a queue.

UMQIndexAssignmentEligibilityStopCompleteInfo
UMQ Index Assignment Eligibility Stop Complete Info class. Contains extended information for UMQ receiver index assignment eligibility stop complete messages. This info object is supplied with a message indicating the a receiver is now no longer eligible for new index assignments from a queue.

UMQIndexInfo
UMQIndexReleasedInfo
Class containing information about UMQ index released events. This info object is delivered with a UMQ Index Released receiver event, containing information identifying the queue, queue instance, and index information associated with the index released event.

UMQMessageId
UMQ Message ID class. Contains information required to identify a UMQ message

UMQMessageTotalLifetimeInfo
UMQQueueIndexInfo
UMQQueueInfo
Base class for UMQ info objects associated with a queue. This class encapsulates the basic information required for any UMQ info object that is associated with a queue, namely the identifying information for the queue (Id and Name) and a set of flags to indicate other information contained in the object.

UMQQueueInstanceInfo
Base class for UMQ info objects associated with a queue instance. This class encapsulates the information required for any UMQ info object that is associated with a queue instance. This includes both the information required to identify the queue (Id and Name) as well as the information needed to identify the queue instance (Index and Name).

UMQRegistrationCompleteInfo
UMQ Registration Complete Info class. Contains extended information for UMQ receiver registration complete messages.

UMQSourceEventAckInfo
UMQ Stability Ack Info class. This info object is delivered with a source event indicating that a message is stable (i.e. has been acknowledged by a queue instance).

UMQSourceEventMessageIdInfo
This class encapsulates information about a message sent to a queue. An object of type UMQSourceEventMessageIdInfo will be delivered with a source event of type LBM.SRC_EVENT_UMQ_MESSAGE_ID_INFO to notify the application of the message id that has been assigned to the message by the queue.

UMQSourceEventRegistrationCompleteInfo
UMQ Source Event Registration Complete Info class. This info object is delivered with a source event indicating that registration is complete to all involved queue instances.

UMQSourceEventULBMessageInfo
UMQ ULB Message Info class. This info object is delivered with a source event indicating that a ULB message has been assigned, consumed, discarded, etc.

UMQSourceEventULBReceiverInfo
UMQ ULB Receiver Info class. This info object is both delivered with a source event and acts as a base class for other ULB source events. In both cases, this object holds information about a ULB receiver.