com.latencybusters.lbm
Class LBMContextStatistics

java.lang.Object
  com.latencybusters.lbm.LBMContextStatistics

public class LBMContextStatistics
extends java.lang.Object

UM Context Statistics

Constructor Summary

LBMContextStatistics()
Instantiate an empty object containing no statistics.

LBMContextStatistics(LBMContext ctx)
Instantiate an object containing the current set of context statistics for a given UM Context.

Method Summary

void	dispose() Free memory associated with this set of statistics
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	lbtrmUnknownMessagesReceived() Number of LBT-RM datagrams received not belonging to any transport session.
long	lbtruUnknownMessagesReceived() Number of LBT-RU datagrams received not belonging to any transport session.
void	refresh(LBMContext ctx) Refresh lbm context statistics for a given LBMContext
long	responseBlocked() Number of incidents where a UM send response call was blocked.
long	responseWouldBlock() Number of incidents where a UM send response call returned EWOULDBLOCK.
long	sendBlocked() Number of incidents where a UM send call was blocked.
long	sendWouldBlock() Number of incidents where a UM send call returned EWOULDBLOCK.
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	topicResolutionBytesReceived() Number of topic resolution datagram bytes received.
long	topicResolutionBytesSent() Number of topic resolution datagram bytes sent.
long	topicResolutionDatagramsDroppedMalformed() Number of topic resolution datagrams discarded due to being malformed or corrupted.
long	topicResolutionDatagramsDroppedType() Number of topic resolution datagrams discarded due to incorrect type.
long	topicResolutionDatagramsDroppedVersion() Number of topic resolution datagrams discarded due to incorrect version.
long	topicResolutionDatagramsReceived() Number of topic resolution datagrams received by this context.
long	topicResolutionDatagramsSendFailed() Number of topic resolution datagram sends that failed.
long	topicResolutionDatagramsSent() Number of topic resolution datagrams sent from this context.
long	topicResolutionReceiverTopics() Number of topics in the receiver topic resolver cache (also referred to as the topic map).
long	topicResolutionSourceTopics() Number of topics in the source topic resolver cache (also known as the topic map).
long	topicResolutionUnresolvedReceiverTopics() Number of unresolved topics in the receiver topic resolver cache (also referred to as the topic map).

Methods inherited from class java.lang.Object

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

Constructor Detail

LBMContextStatistics

public LBMContextStatistics()

Instantiate an empty object containing no statistics.

LBMContextStatistics

public LBMContextStatistics(LBMContext ctx)
                     throws LBMException

Instantiate an object containing the current set of context statistics for a given UM Context.

Parameters:

ctx - LBMContext object

Throws:

LBMException - if any error occurred retrieving context statistics.

See Also:

refresh(com.latencybusters.lbm.LBMContext)

Method Detail

refresh

public void refresh(LBMContext ctx)
             throws LBMException

Refresh lbm context statistics for a given LBMContext

Parameters:

ctx - LBMContext object

Throws:

LBMException - if any error occurred retrieving context statistics.

dispose

public void dispose()

Free memory associated with this set of statistics

finalize

protected void finalize()

Overrides:

finalize in class java.lang.Object

topicResolutionDatagramsSent

public long topicResolutionDatagramsSent()
                                  throws LBMException

Number of topic resolution datagrams sent from this context. Each datagram can contain one or more advertisements, queries, query responses, etc. from source or receiver objects. A faster accumulation of counts typically indicates more source, receiver, and/or context objects are being created.

Returns:

Number of topic resolution datagrams sent

Throws:

LBMException - if any error occurred retrieving topic resolution datagrams sent

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionDatagramsReceived

public long topicResolutionDatagramsReceived()
                                      throws LBMException

Number of topic resolution datagrams received by this context. Each datagram can contain one or more advertisements, queries, query responses, etc. from source or receiver objects. A faster accumulation of counts typically indicates more source, receiver, and/or context objects are being created.

Returns:

Number of topic resolution datagrams received by this context

Throws:

LBMException - if any error occurred retrieving topic resolution datagrams received

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionBytesSent

public long topicResolutionBytesSent()
                              throws LBMException

Number of topic resolution datagram bytes sent. This count is triggered under the same circumstances as datagrams sent (above), but measures the total number of byte for all datagrams sent, including their headers.

Returns:

Number of topic resolution datagram bytes sent

Throws:

LBMException - if any error occurred retrieving bytes sent of topic resolution.

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionBytesReceived

public long topicResolutionBytesReceived()
                                  throws LBMException

Number of topic resolution datagram bytes received. This count is triggered under the same circumstances as datagrams received (above), but measures the total number of bytes for all datagrams received, including their headers.

Returns:

Number of topic resolution datagram bytes received

Throws:

LBMException - if any error occurred retrieving bytes received of topic resolution.

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionDatagramsDroppedVersion

public long topicResolutionDatagramsDroppedVersion()
                                            throws LBMException

Number of topic resolution datagrams discarded due to incorrect version. The datagram's version field must match the expectations of the receiving context.

Returns:

Number of topic resolution datagrams discarded due to incorrect version

Throws:

LBMException - if any error occurred retrieving topic resolution datagrams discarded due to incorrect version.

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionDatagramsDroppedType

public long topicResolutionDatagramsDroppedType()
                                         throws LBMException

Number of topic resolution datagrams discarded due to incorrect type. The datagram's type field must match the expectations of the receiving context.

Returns:

Number of topic resolution datagrams discarded due to incorrect type

Throws:

LBMException - if any error occurred retrieving topic resolution datagrams discarded due to incorrect type

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionDatagramsDroppedMalformed

public long topicResolutionDatagramsDroppedMalformed()
                                              throws LBMException

Number of topic resolution datagrams discarded due to being malformed or corrupted.

Returns:

Number of topic resolution datagrams discarded due to being malformed

Throws:

LBMException - if any error occurred retrieving topic resolution datagrams discarded due to a malformed header

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionDatagramsSendFailed

public long topicResolutionDatagramsSendFailed()
                                        throws LBMException

Number of topic resolution datagram sends that failed. This count should be at or at least near 0.

Returns:

Number of topic resolution datagram sends that failed

Throws:

LBMException - if any error occurred retrieving topic resolution datagram send failures.

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionSourceTopics

public long topicResolutionSourceTopics()
                                 throws LBMException

Number of topics in the source topic resolver cache (also known as the topic map). Inordinately large or growing values here may impact performance.

Returns:

Number of topics in the source topic map

Throws:

LBMException - if any error occurred retrieving the number of topics in the source topic map.

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionReceiverTopics

public long topicResolutionReceiverTopics()
                                   throws LBMException

Number of topics in the receiver topic resolver cache (also referred to as the topic map). Inordinately large or growing values here may impact performance.

Returns:

Number of topics in the receiver topic map

Throws:

LBMException - if any error occurred retrieving the number of topics in the receiver topic map.

See Also:

LBMContextStatistics(LBMContext), LBM

topicResolutionUnresolvedReceiverTopics

public long topicResolutionUnresolvedReceiverTopics()
                                             throws LBMException

Number of unresolved topics in the receiver topic resolver cache (also referred to as the topic map). Inordinately large or growing values here may impact performance.

Returns:

Number of unresolved topics is the receiver topic map

Throws:

LBMException - if any error occurred retrieving the number of unresolved topics in the receiver topic map.

See Also:

LBMContextStatistics(LBMContext), LBM

lbtrmUnknownMessagesReceived

public long lbtrmUnknownMessagesReceived()
                                  throws LBMException

Number of LBT-RM datagrams received not belonging to any transport session. Such occurrences should be investigated. These datagrams can be from a source in a different topic resolution domain targeting the same group (or IP) and port as a source of interest on this receiver's topic resolution domain. Among less likely possibilities would be an attempt to spoof UM messages.

Returns:

Number of LBT-RM datagrams received not belonging to any transport session

Throws:

LBMException - if any error occurred retrieving the number of LBT-RM datagrams received not belonging to any transport session

See Also:

LBMContextStatistics(LBMContext), LBM

lbtruUnknownMessagesReceived

public long lbtruUnknownMessagesReceived()
                                  throws LBMException

Number of LBT-RU datagrams received not belonging to any transport session. Such occurrences should be investigated. These datagrams can be from a source in a different topic resolution domain targeting the same group (or IP) and port as a source of interest on this receiver's topic resolution domain. Among less likely possibilities would be an attempt to spoof UM messages.

Returns:

Number of LBT-RU datagrams received not belonging to any transport session

Throws:

LBMException - if any error occurred retrieving the number of LBT-RU datagrams received not belonging to any transport session

See Also:

LBMContextStatistics(LBMContext), LBM

sendBlocked

public long sendBlocked()
                 throws LBMException

Number of incidents where a UM send call was blocked. Unusually high counts could indicate performance degradation or I/O problems.

Returns:

Number of incidents where a UM send call was blocked

Throws:

LBMException - if any error occurred retrieving the number of UM send calls which blocked.

See Also:

LBMContextStatistics(LBMContext), LBM

sendWouldBlock

public long sendWouldBlock()
                    throws LBMException

Number of incidents where a UM send call returned EWOULDBLOCK. This is when a send call set to be nonblocking encounters an error condition where it would otherwise be blocked. Under normal operating conditions, this count should be at or near 0.

Returns:

Number of incidents where a UM send call returned EWOULDBLOCK

Throws:

LBMException - if any error occurred retrieving the number of UM send calls which returned EWOULDBLOCK

See Also:

LBMContextStatistics(LBMContext), LBM

responseBlocked

public long responseBlocked()
                     throws LBMException

Number of incidents where a UM send response call was blocked. Unusually high counts could indicate performance degradation or I/O problems.

Returns:

Number of incidents where a UM send response call was blocked

Throws:

LBMException - if any error occurred retrieving the number of UM send response calls which blocked

See Also:

LBMContextStatistics(LBMContext), LBM

responseWouldBlock

public long responseWouldBlock()
                        throws LBMException

Number of incidents where a UM send response call returned EWOULDBLOCK. This is when a send response call set to be nonblocking encounters an error condition where it would otherwise be blocked. Under normal operating conditions, this count should be at or near 0.

Returns:

Number of incidents where a UM send response call returned EWOULDBLOCK

Throws:

LBMException - if any error occurred retrieving the number of UM send response calls which returned EWOULDBLOCK

See Also:

LBMContextStatistics(LBMContext), LBM

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