AccumulatedTimerSupplier (Dataflow Library Distribution Project 8.0.0-98 API)

All Superinterfaces:

StatisticSupplier

All Known Implementing Classes:

AccumulatedTimer, AccumulatedTimerSnapshot
```
public interface AccumulatedTimerSupplier
extends StatisticSupplier
```
Abstract statistic that represents "wall-clock" time of some runtime activity. Timers consist of a state(unavailable, started, stopped), a start time, and an end time. Timers always aggregate in the following way:
1. The aggregated StatisticSupplier.getState() is StatisticState.UNAVAILABLE if all partitions are unavailable. Otherwise the aggregated StatisticSupplier.getState() is StatisticState.FINISHED if all partitions are StatisticState.FINISHED. Otherwise the aggregated StatisticSupplier.getState() is StatisticState.ACTIVE
2. The aggregated getAccumulatedTimeMillis() is defined to be the sum over all partitions of the partition's getAccumulatedTimeMillis()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`long`	`getAccumulatedTimeMillis()`	The accumulated time so far.
`AccumulatedTimerSupplier`	`snapshot()`	Creates a snapshot of this timer.

Methods inherited from interface com.pervasive.datarush.monitoring.StatisticSupplier
getState

- Method Detail
  - getAccumulatedTimeMillis
```
long getAccumulatedTimeMillis()
```
    The accumulated time so far. For aggregations, this is the sum over all partitions of the to be the sum over all partitions of the partition's getAccumulatedTimeMillis(). This value is undefined if the timer is StatisticState.UNAVAILABLE.
    
    Returns:
    
    the accumulated time in milliseconds.
  - snapshot
```
AccumulatedTimerSupplier snapshot()
```
    Creates a snapshot of this timer. If the timer is in the StatisticState.ACTIVE
    
    Specified by:
    
    snapshot in interface StatisticSupplier
    
    Returns:
    
    a snapshot of this statistic.