Package de.quantummaid.eventmaid.channel.statistics

Class ChannelStatistics

java.lang.Object

de.quantummaid.eventmaid.channel.statistics.ChannelStatistics

public final class ChannelStatistics
extends Object

A collection of statistics about the messages, that have been processed up to the point the statistics were requested.

The timestamp defines the approximate time, when the statistics were queried. But no locking during the request is performed. So the values should be seen as approximations.

The value of getAcceptedMessages() defines the number of messages the Channel has been accepted without an exception. getQueuedMessages() returns, how many messages have been accepted, but due to not enough resources have been queued. The processing of queued messages will automatically be continued, when resources become available and the Channel is not closed before. getBlockedMessages() and getForgottenMessages() relate to the results of Filters being applied. Messages, that have been blocked by a Filter stop their propagation through the Channel. Forgotten messages are those messages, that have not explicitly marked as passed or blocked by a Filter. Usually they are the result of a bug inside on of the Filters. Once a message passed all Filter the final Action is executed. The getSuccessfulMessages() returns the number of messages, that have been delivered without exceptions. In case of an exception during the delivery, the message is marked as failed. getFailedMessages() returns the amount of those messages.

See Also:

EventMaid Documentation

Constructor Summary

Constructors

Constructor	Description
ChannelStatistics()

Method Summary

Modifier and Type	Method	Description
static ChannelStatistics	channelStatistics(Date timestamp, BigInteger acceptedMessages, BigInteger queuedMessages, BigInteger blockedMessages, BigInteger forgottenMessages, BigInteger successfulMessages, BigInteger failedMessages)
BigInteger	getAcceptedMessages()
BigInteger	getBlockedMessages()
BigInteger	getFailedMessages()
BigInteger	getForgottenMessages()
BigInteger	getQueuedMessages()
BigInteger	getSuccessfulMessages()
Date	getTimestamp()

Methods inherited from class java.lang.Object

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

Constructor Detail

ChannelStatistics

public ChannelStatistics()

Method Detail

channelStatistics

public static ChannelStatistics channelStatistics(Date timestamp,
                                                  BigInteger acceptedMessages,
                                                  BigInteger queuedMessages,
                                                  BigInteger blockedMessages,
                                                  BigInteger forgottenMessages,
                                                  BigInteger successfulMessages,
                                                  BigInteger failedMessages)

getTimestamp

public Date getTimestamp()

getAcceptedMessages

public BigInteger getAcceptedMessages()

getQueuedMessages

public BigInteger getQueuedMessages()

getBlockedMessages

public BigInteger getBlockedMessages()

getForgottenMessages

public BigInteger getForgottenMessages()

getSuccessfulMessages

public BigInteger getSuccessfulMessages()

getFailedMessages

public BigInteger getFailedMessages()