com.latencybusters.lbm
Class LBMEventQueueStatistics

java.lang.Object
  com.latencybusters.lbm.LBMEventQueueStatistics

public class LBMEventQueueStatistics
extends java.lang.Object

UM EventQueue Statistics

Constructor Summary

LBMEventQueueStatistics()
Instantiate an empty object containing no statistics.

LBMEventQueueStatistics(LBMEventQueue evq)
Instantiate an object containing the current set of event queue statistics for a given UM Event Queue.

Method Summary

long	callbackEvents() Number of callback events currently in the event queue, i.e., a snapshot.
long	callbackEventsMaximumServiceTime() Maximum service time for callback events (in microseconds).
long	callbackEventsMeanServiceTime() Mean service time for callback events (in microseconds).
long	callbackEventsMinimumServiceTime() Minimum service time for callback events (in microseconds).
long	callbackEventsTotal() Total accumulated number of callback events that have been added to the event queue even if subsequently de-queued) since last reset.
long	cancelEvents() Number of cancel events currently in the event queue, i.e., a snapshot.
long	cancelEventsMaximumServiceTime() Maximum service time for cancel events.
long	cancelEventsMeanServiceTime() Mean service time for cancel events.
long	cancelEventsMinimumServiceTime() Minimum service time for cancel events.
long	cancelEventsTotal() Total accumulated number of cancel events that have been added to the event queue (even if subsequently de-queued) since last reset.
long	contextSourceEvents() Number of context source events currently in the event queue, i.e., a snapshot.
long	contextSourceEventsMaximumServiceTime() Maximum service time for context source events (in microseconds).
long	contextSourceEventsMeanServiceTime() Mean service time for context source events (in microseconds).
long	contextSourceEventsMinimumServiceTime() Minimum service time for context source events (in microseconds).
long	contextSourceEventsTotal() Total accumulated number of context source events that have been added to the event queue (even if subsequently de-queued) since last reset.
long	dataMessages() Number of data messages currently in the event queue, i.e., a snapshot.
long	dataMessagesMaximumServiceTime() Maximum service time for data messages (in microseconds).
long	dataMessagesMeanServiceTime() Mean service time for data messages (in microseconds).
long	dataMessagesMinimumServiceTime() Minimum service time for data messages (in microseconds).
long	dataMessagesTotal() Total accumulated number of data messages that have been added to the event queue (even if subsequently de-queued) since last reset.
void	dispose() Free memory associated with this set of statistics.
long	events() Total number of events (including messages) currently in the event queue, i.e., a snapshot.
long	eventsTotal() Total accumulated number of events (including messages) that have been added to the event queue (even if subsequently de-queued) since last reset.
protected void	finalize()
java.lang.String	getApplicationSourceId() Retrieve the application source identifier associated with this set of statistics.
long	getContextId() Retrieve the sending context ID associated with this set of statistics.
long	getProcessId() Retrieve the sending process ID associated with this set of statistics.
java.net.InetAddress	getSender() Retrieve the IP sender address associated with this set of statistics.
java.util.Date	getTimestamp() Retrieve the timestamp associated with this set of statistics.
long	ioEvents() Number of I/O events currently in the event queue, i.e., a snapshot.
long	ioEventsMaximumServiceTime() Maximum service time for I/O events (in microseconds).
long	ioEventsMeanServiceTime() Mean service time for I/O events (in microseconds).
long	ioEventsMinimumServiceTime() Minimum Service Time for I/O Events (in microseconds).
long	ioEventsTotal() Total accumulated number of I/O events that have been added to the event queue (even if subsequently de-queued) since last reset.
long	maximumAge() Maximum age of event queue entry when dequeued (in microseconds).
long	meanAge() Mean age of event queue entries when dequeued (in microseconds).
long	minimumAge() Minimum age of event queue entry when dequeued (in microseconds).
void	refresh(LBMEventQueue evq) Refresh event queue statistics for a given LBMEventQueue
long	responseMessages() Number of response messages (from receiver objects) currently in the event queue, i.e., a snapshot.
long	responseMessagesMaximumServiceTime() Maximum service time for response messages (in microseconds).
long	responseMessagesMeanServiceTime() Mean service time for response messages (in microseconds).
long	responseMessagesMinimumServiceTime() Minimum service time for response messages (in microseconds).
long	responseMessagesTotal() Total accumulated number of response messages that have been added to the event queue (even if subsequently de-queued) since last reset.
protected void	setApplicationSourceId(java.lang.String appid)
protected void	setContextId(long cid)
protected void	setProcessId(long pid)
protected void	setSender(long ip)
protected void	setTimestamp(long ts)
long	sourceEvents() Number of source events currently in the event queue, i.e., a snapshot.
long	sourceEventsMaximumServiceTime() Maximum service time for source events (in microseconds).
long	sourceEventsMeanServiceTime() Mean service time for source events (in microseconds).
long	sourceEventsMinimumServiceTime() Minimum service time for source events (in microseconds).
long	sourceEventsTotal() Total accumulated number of source events that have been added to the event queue (even if subsequently de-queued) since last reset.
long	timerEvents() Number of timer events currently in the event queue, i.e., a snapshot.
long	timerEventsMaximumServiceTime() Maximum service time for timer events (in microseconds).
long	timerEventsMeanServiceTime() Mean service time for timer events (in microseconds).
long	timerEventsMinimumServiceTime() Minimum service time for timer events (in microseconds).
long	timerEventsTotal() Total accumulated number of timer events that have been added to the event queue (even if subsequently de-queued) since last reset.
long	topiclessImmediateMessages() Number of topic-less Multicast Immediate Messaging (MIM) messages currently in the event queue, i.e., a snapshot.
long	topiclessImmediateMessagesMaximumServiceTime() Maximum service time for topic-less Multicast Immediate Messaging (MIM) messages (in microseconds).
long	topiclessImmediateMessagesMeanServiceTime() Mean service time for topic-less Multicast Immediate Messaging (MIM) messages (in microseconds).
long	topiclessImmediateMessagesMinimumServiceTime() Minimum service time for topic-less Multicast Immediate Messaging (MIM) messages (in microseconds).
long	topiclessImmediateMessagesTotal() Total accumulated number of topic-less Multicast Immediate Messaging (MIM) messages that have been added to the event queue (even if subsequently de-queued) since last reset.
long	unblockEvents() Number of unblock events currently in the event queue, i.e., a snapshot.
long	unblockEventsTotal() Total accumulated number of unblock events that have been added to the event queue (even if subsequently de-queued) since last reset.
long	wildcardReceiverMessages() Number of wildcard receiver messages currently in the event queue, i.e., a snapshot.
long	wildcardReceiverMessagesMaximumServiceTime() Maximum service time for wildcard receiver messages (in microseconds).
long	wildcardReceiverMessagesMeanServiceTime() Mean service time for wildcard receiver messages (in microseconds).
long	wildcardReceiverMessagesMinimumServiceTime() Minimum service time for wildcard receiver messages (in microseconds).
long	wildcardReceiverMessagesTotal() Total accumulated number of wildcard receiver messages that have been added to the event queue (even if subsequently de-queued) since last reset.

Methods inherited from class java.lang.Object

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

Constructor Detail

LBMEventQueueStatistics

public LBMEventQueueStatistics()

Instantiate an empty object containing no statistics.

LBMEventQueueStatistics

public LBMEventQueueStatistics(LBMEventQueue evq)
                        throws LBMException

Instantiate an object containing the current set of event queue statistics for a given UM Event Queue.

Parameters:

evq - LBMEventQueue object

Throws:

LBMException - if any error occurred retrieving event queue statistics.

See Also:

refresh(com.latencybusters.lbm.LBMEventQueue)

Method Detail

refresh

public void refresh(LBMEventQueue evq)
             throws LBMException

Refresh event queue statistics for a given LBMEventQueue

Parameters:

evq - LBMEventQueue object

Throws:

LBMException - if any error occurred retrieving event queue statistics.

dispose

public void dispose()

Free memory associated with this set of statistics.

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

dataMessages

public long dataMessages()
                  throws LBMException

Number of data messages currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Data messages currently in the event queue

Throws:

LBMException - if any error occurred retrieving data messages.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

dataMessagesTotal

public long dataMessagesTotal()
                       throws LBMException

Total accumulated number of data messages that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total data messages enqueued since last reset

Throws:

LBMException - if any error occurred retrieving total data messages.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

dataMessagesMinimumServiceTime

public long dataMessagesMinimumServiceTime()
                                    throws LBMException

Minimum service time for data messages (in microseconds). This is the low-water mark (i.e., the shortest so far) for data message service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time for data messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving minimum service time.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

dataMessagesMeanServiceTime

public long dataMessagesMeanServiceTime()
                                 throws LBMException

Mean service time for data messages (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated data message service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time for data messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving mean service time.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

dataMessagesMaximumServiceTime

public long dataMessagesMaximumServiceTime()
                                    throws LBMException

Maximum service time for data messages (in microseconds). This is the high-water mark (i.e., the longest so far) for data message service durations measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time for data messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving maximum service time.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

responseMessages

public long responseMessages()
                      throws LBMException

Number of response messages (from receiver objects) currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Response messages currently in the event queue

Throws:

LBMException - if any error occurred retrieving response messages.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

responseMessagesTotal

public long responseMessagesTotal()
                           throws LBMException

Total accumulated number of response messages that have been added to the event queue (even if subsequently de-queued) since last reset.

Returns:

Total response messages enqueued since last reset

Throws:

LBMException - if any error occurred retrieving total response messages.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

responseMessagesMinimumServiceTime

public long responseMessagesMinimumServiceTime()
                                        throws LBMException

Minimum service time for response messages (in microseconds). This is the low-water mark (i.e., the shortest so far) for response message service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time for response messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving minimum service time.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

responseMessagesMeanServiceTime

public long responseMessagesMeanServiceTime()
                                     throws LBMException

Mean service time for response messages (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated response message service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time for response messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving mean service time.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

responseMessagesMaximumServiceTime

public long responseMessagesMaximumServiceTime()
                                        throws LBMException

Maximum service time for response messages (in microseconds). This is the high-water mark (i.e., the longest so far) for response message service durations measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time for response messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving maximum service time.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

topiclessImmediateMessages

public long topiclessImmediateMessages()
                                throws LBMException

Number of topic-less Multicast Immediate Messaging (MIM) messages currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Topic-less MIM messages currently in the event queue

Throws:

LBMException - if any error occurred retrieving topicless immediate messages

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

topiclessImmediateMessagesTotal

public long topiclessImmediateMessagesTotal()
                                     throws LBMException

Total accumulated number of topic-less Multicast Immediate Messaging (MIM) messages that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total topic-less MIM messages enqueued since last reset

Throws:

LBMException - if any error occurred retrieving total topicless immediate messages

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

topiclessImmediateMessagesMinimumServiceTime

public long topiclessImmediateMessagesMinimumServiceTime()
                                                  throws LBMException

Minimum service time for topic-less Multicast Immediate Messaging (MIM) messages (in microseconds). This is the low-water mark (i.e., the shortest so far) for topic-less MIM message service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time for topic-less MIM messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving minimum service time.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

topiclessImmediateMessagesMeanServiceTime

public long topiclessImmediateMessagesMeanServiceTime()
                                               throws LBMException

Mean service time for topic-less Multicast Immediate Messaging (MIM) messages (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated topic-less MIM message service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time for topic-less MIM messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving mean service time

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

topiclessImmediateMessagesMaximumServiceTime

public long topiclessImmediateMessagesMaximumServiceTime()
                                                  throws LBMException

Maximum service time for topic-less Multicast Immediate Messaging (MIM) messages (in microseconds). This is the high-water mark (i.e., the longest so far) for topic-less MIM message service durations measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time for topic-less MIM messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving maximum service time

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

wildcardReceiverMessages

public long wildcardReceiverMessages()
                              throws LBMException

Number of wildcard receiver messages currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of wildcard messages currently in the event queue

Throws:

LBMException - if any error occurred retrieving the number of wildcard messages enqueued.

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

wildcardReceiverMessagesTotal

public long wildcardReceiverMessagesTotal()
                                   throws LBMException

Total accumulated number of wildcard receiver messages that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of wildcard messages enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the total number of wildcard messages

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

wildcardReceiverMessagesMinimumServiceTime

public long wildcardReceiverMessagesMinimumServiceTime()
                                                throws LBMException

Minimum service time for wildcard receiver messages (in microseconds). This is the low-water mark (i.e., the shortest so far) for wildcard receiver message service durations measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time of wildcard messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving the minimum service time of wildcard messages

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

wildcardReceiverMessagesMeanServiceTime

public long wildcardReceiverMessagesMeanServiceTime()
                                             throws LBMException

Mean service time for wildcard receiver messages (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated wildcard receiver message service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time of wildcard messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving the mean service time of wildcard messages

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

wildcardReceiverMessagesMaximumServiceTime

public long wildcardReceiverMessagesMaximumServiceTime()
                                                throws LBMException

Maximum service time for wildcard receiver messages (in microseconds). This is the high-water mark (i.e., the longest so far) for wildcard receiver message service durations measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time of wildcard messages (in microseconds)

Throws:

LBMException - if any error occurred retrieving the maximum service time of wildcard messages

See Also:

LBMEventQueueStatistics(LBMEventQueue), LBM

ioEvents

public long ioEvents()
              throws LBMException

Number of I/O events currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of I/O events currently in the event queue

Throws:

LBMException - if any error occurred retrieving the statistics.

ioEventsTotal

public long ioEventsTotal()
                   throws LBMException

Total accumulated number of I/O events that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of I/O events enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the statistics.

ioEventsMinimumServiceTime

public long ioEventsMinimumServiceTime()
                                throws LBMException

Minimum Service Time for I/O Events (in microseconds). This is the low-water mark (i.e., the shortest so far) for I/O event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time for I/O events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

ioEventsMeanServiceTime

public long ioEventsMeanServiceTime()
                             throws LBMException

Mean service time for I/O events (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated I/O event service durations, measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time for I/O events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

ioEventsMaximumServiceTime

public long ioEventsMaximumServiceTime()
                                throws LBMException

Maximum service time for I/O events (in microseconds). This is the high-water mark (i.e., the longest so far) for I/O event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time for I/O events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

timerEvents

public long timerEvents()
                 throws LBMException

Number of timer events currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of timer events currently in the event queue

Throws:

LBMException - if any error occurred retrieving the statistics.

timerEventsTotal

public long timerEventsTotal()
                      throws LBMException

Total accumulated number of timer events that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of timer events enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the statistics.

timerEventsMinimumServiceTime

public long timerEventsMinimumServiceTime()
                                   throws LBMException

Minimum service time for timer events (in microseconds). This is the low-water mark (i.e., the shortest so far) for timer event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time for timer events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

timerEventsMeanServiceTime

public long timerEventsMeanServiceTime()
                                throws LBMException

Mean service time for timer events (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated timer event service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time for timer events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

timerEventsMaximumServiceTime

public long timerEventsMaximumServiceTime()
                                   throws LBMException

Maximum service time for timer events (in microseconds). This is the high-water mark (i.e., the longest so far) for timer event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time for timer events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

sourceEvents

public long sourceEvents()
                  throws LBMException

Number of source events currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of source events currently in the event queue

Throws:

LBMException - if any error occurred retrieving the statistics.

sourceEventsTotal

public long sourceEventsTotal()
                       throws LBMException

Total accumulated number of source events that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of source events enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the statistics.

sourceEventsMinimumServiceTime

public long sourceEventsMinimumServiceTime()
                                    throws LBMException

Minimum service time for source events (in microseconds). This is the low-water mark (i.e., the shortest so far) for source event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time for source events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

sourceEventsMeanServiceTime

public long sourceEventsMeanServiceTime()
                                 throws LBMException

Mean service time for source events (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated source event service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time for source events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

sourceEventsMaximumServiceTime

public long sourceEventsMaximumServiceTime()
                                    throws LBMException

Maximum service time for source events (in microseconds). This is the high-water mark (i.e., the longest so far) for source event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time for source events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

unblockEvents

public long unblockEvents()
                   throws LBMException

Number of unblock events currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of unblock events currently in the event queue

Throws:

LBMException - if any error occurred retrieving the statistics.

unblockEventsTotal

public long unblockEventsTotal()
                        throws LBMException

Total accumulated number of unblock events that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of unblock events enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the statistics.

cancelEvents

public long cancelEvents()
                  throws LBMException

Number of cancel events currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of cancel events currently in the event queue

Throws:

LBMException - if any error occurred retrieving the statistics.

cancelEventsTotal

public long cancelEventsTotal()
                       throws LBMException

Total accumulated number of cancel events that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of cancel events enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the statistics.

cancelEventsMinimumServiceTime

public long cancelEventsMinimumServiceTime()
                                    throws LBMException

Minimum service time for cancel events. Cancel events as seen by the event queue do not actually consume service time, so we do not recommend the general use of this counter.

Returns:

Minimum service time for cancel events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

cancelEventsMeanServiceTime

public long cancelEventsMeanServiceTime()
                                 throws LBMException

Mean service time for cancel events. Cancel events as seen by the event queue do not actually consume service time, so we do not recommend the general use of this counter.

Returns:

Mean service time for cancel events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

cancelEventsMaximumServiceTime

public long cancelEventsMaximumServiceTime()
                                    throws LBMException

Maximum service time for cancel events. Cancel events as seen by the event queue do not actually consume service time, so we do not recommend the general use of this counter.

Returns:

Maximum service time for cancel events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

callbackEvents

public long callbackEvents()
                    throws LBMException

Number of callback events currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of callback events currently in the event queue

Throws:

LBMException - if any error occurred retrieving the statistics.

callbackEventsTotal

public long callbackEventsTotal()
                         throws LBMException

Total accumulated number of callback events that have been added to the event queue even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of callback events enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the statistics.

callbackEventsMinimumServiceTime

public long callbackEventsMinimumServiceTime()
                                      throws LBMException

Minimum service time for callback events (in microseconds). This is the low-water mark (i.e., the shortest so far) for callback event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time for callback events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

callbackEventsMeanServiceTime

public long callbackEventsMeanServiceTime()
                                   throws LBMException

Mean service time for callback events (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated callback event service durations, measured from the point of de-queuement until the application has finished servicing the message. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time for callback events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

callbackEventsMaximumServiceTime

public long callbackEventsMaximumServiceTime()
                                      throws LBMException

Maximum service time for callback events (in microseconds). This is the high-water mark (i.e., the longest so far) for callback event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time for callback events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

contextSourceEvents

public long contextSourceEvents()
                         throws LBMException

Number of context source events currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of context source events currently in the event queue

Throws:

LBMException - if any error occurred retrieving the statistics.

contextSourceEventsTotal

public long contextSourceEventsTotal()
                              throws LBMException

Total accumulated number of context source events that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of context source events enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the statistics.

contextSourceEventsMinimumServiceTime

public long contextSourceEventsMinimumServiceTime()
                                           throws LBMException

Minimum service time for context source events (in microseconds). This is the low-water mark (i.e., the shortest so far) for context source event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Minimum service time for context source events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

contextSourceEventsMeanServiceTime

public long contextSourceEventsMeanServiceTime()
                                        throws LBMException

Mean service time for context source events (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated context source event service durations, measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Mean service time for context source events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

contextSourceEventsMaximumServiceTime

public long contextSourceEventsMaximumServiceTime()
                                           throws LBMException

Maximum service time for context source events (in microseconds). This is the high-water mark (i.e., the longest so far) for context source event service durations measured from the point of de-queuement until the application has finished servicing the event. Configuration option queue_service_time_enabled must be activated.

Returns:

Maximum service time for context source events (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

events

public long events()
            throws LBMException

Total number of events (including messages) currently in the event queue, i.e., a snapshot. Configuration option queue_count_enabled must be activated.

Returns:

Number of events currently in the event queue

Throws:

LBMException - if any error occurred retrieving the statistics.

eventsTotal

public long eventsTotal()
                 throws LBMException

Total accumulated number of events (including messages) that have been added to the event queue (even if subsequently de-queued) since last reset. Configuration option queue_count_enabled must be activated.

Returns:

Total number of events that have been enqueued since last reset

Throws:

LBMException - if any error occurred retrieving the statistics.

minimumAge

public long minimumAge()
                throws LBMException

Minimum age of event queue entry when dequeued (in microseconds). This is the low-water mark for the measured age of any event or message (i.e., the shortest one so far) from the point of enqueuement until de-queuement. Configuration option queue_age_enabled must be activated.

Returns:

Minimum age of event queue entry when dequeued (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

meanAge

public long meanAge()
             throws LBMException

Mean age of event queue entries when dequeued (in microseconds). This is an exponentially weighted moving average (weighted to more recent) for accumulated event or message ages (measured from the point enqueuement until de-queuement). Configuration option queue_age_enabled must be activated.

Returns:

Mean age of event queue entry when dequeued (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

maximumAge

public long maximumAge()
                throws LBMException

Maximum age of event queue entry when dequeued (in microseconds). This is the high-water mark for the measured age of any event or message (i.e., the oldest one so far) from the point of enqueuement until de-queuement. Configuration option queue_age_enabled must be activated.

Returns:

Maximum age of event queue entry when dequeued (in microseconds)

Throws:

LBMException - if any error occurred retrieving the statistics.

setSender

protected void setSender(long ip)

setTimestamp

protected void setTimestamp(long ts)

setApplicationSourceId

protected void setApplicationSourceId(java.lang.String appid)

setProcessId

protected void setProcessId(long pid)

setContextId

protected void setContextId(long cid)

getApplicationSourceId

public java.lang.String getApplicationSourceId()

Retrieve the application source identifier associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

Application source ID

getSender

public java.net.InetAddress getSender()
                               throws java.net.UnknownHostException

Retrieve the IP sender address associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

InetAddress object corresponding to the statistics' sender IP address

Throws:

java.net.UnknownHostException - if IP address is of illegal length.

getTimestamp

public java.util.Date getTimestamp()

Retrieve the timestamp associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

Timestamp Date object

getProcessId

public long getProcessId()

Retrieve the sending process ID associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

Process ID

getContextId

public long getContextId()

Retrieve the sending context ID associated with this set of statistics. This attribute is only set for statistics returned by the UM Monitoring framework.

Returns:

Context ID