com.solacesystems.jcsmp

Class JCSMPStats

java.lang.Object

com.solacesystems.jcsmp.JCSMPStats

Direct Known Subclasses:

JCSMPRuntime, JCSMPSessionStats

public abstract class JCSMPStats
extends Object

Represents a set of message statistics.

Session statistics are enumerated as members of the StatType class and can be accessed through JCSMPSessionStats. The API also provides a set of Java VM-wide runtime statistics (which span across JCSMP sessions), which are enumerated in RuntimeStatType, and can be accessed through JCSMPRuntime.

Applications may experience reduced performance when statistics collection is enabled. If your application does not require session or runtime statistics, you can disable statistics collection by defining the environment variable JCSMP_DISABLE_STATS.

See Also:

StatType, RuntimeStatType

Constructor Summary

Constructors

Constructor and Description
JCSMPStats(String title) Deprecated.
JCSMPStats(String title, JCSMPSession session)

Method Summary

Modifier and Type	Method and Description
long	getLastStatsReset() Gets the date/time of the last reset of this instance.
long	getStat(StatType t) Poll a specific statistic.
String	getTitle() Gets the title this instance of JCSMPStats was initialized with.
void	resetStats() Reset the statistics in this instance of JCSMPStats.
String	toString() Returns a string representation of the statistics set.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

JCSMPStats

@Deprecated
public JCSMPStats(String title)

Deprecated.

Constructs a JCSMPSessionStats object.

JCSMPStats

public JCSMPStats(String title,
                  JCSMPSession session)

Method Detail

getTitle

public String getTitle()

Gets the title this instance of JCSMPStats was initialized with.

Returns:

The title this instance was initialized with.

getLastStatsReset

public long getLastStatsReset()

Gets the date/time of the last reset of this instance.

Returns:

The time of the last statistics reset, in the same format as System.currentTimeMillis().

resetStats

public void resetStats()

Reset the statistics in this instance of JCSMPStats.

getStat

public long getStat(StatType t)

Poll a specific statistic.

Returns:

The requested statistic's current value.

toString

public String toString()

Returns a string representation of the statistics set.

Overrides:

toString in class Object