Package org.pipservices3.components.count

Class CounterTiming

java.lang.Object

org.pipservices3.components.count.CounterTiming

public class CounterTiming
extends Object

Callback object returned by ICounters.beginTiming(String) to end timing of execution block and update the associated counter.

### Example ###

 
 CounterTiming timing = counters.beginTiming("mymethod.exec_time");
 try {
     ...
 } finally {
   timing.endTiming();
 }
 
 

Constructor Summary

Constructors

Constructor	Description
CounterTiming()	Creates a new instance of the timing callback object.
CounterTiming(String counter, ICounterTimingCallback callback)	Creates a new instance of the timing callback object.

Method Summary

Modifier and Type	Method	Description
void	endTiming()	Ends timing of an execution block, calculates elapsed time and updates the associated counter.

Methods inherited from class java.lang.Object

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

Constructor Details

CounterTiming

public CounterTiming()

Creates a new instance of the timing callback object.

CounterTiming

public CounterTiming(String counter,
 ICounterTimingCallback callback)

Creates a new instance of the timing callback object.

Parameters:

counter - an associated counter name

callback - a callback that shall be called when endTiming is called.

Method Details

endTiming

public void endTiming()

Ends timing of an execution block, calculates elapsed time and updates the associated counter.