Package org.eclipse.microprofile.metrics
Interface Timer
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
Timer.Context
A timing context.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description long
getCount()
Duration
getElapsedTime()
Returns the total elapsed timing durations of all completed timing events that are recorded withupdate(Duration)
.Snapshot
getSnapshot()
Returns a snapshot of the values.Timer.Context
time()
Returns a newTimer.Context
.void
time(Runnable event)
Times and records the duration of event.<T> T
time(Callable<T> event)
Times and records the duration of event.void
update(Duration duration)
Adds a recorded duration.
-
-
-
Method Detail
-
update
void update(Duration duration)
Adds a recorded duration.- Parameters:
duration
- the length of theduration
-
time
<T> T time(Callable<T> event) throws Exception
Times and records the duration of event.- Type Parameters:
T
- the type of the value returned byevent
- Parameters:
event
- aCallable
whoseCallable.call()
method implements a process whose duration should be timed- Returns:
- the value returned by
event
- Throws:
Exception
- ifevent
throws anException
-
time
void time(Runnable event)
Times and records the duration of event.- Parameters:
event
- aRunnable
whoseRunnable.run()
method implements a process whose duration should be timed
-
time
Timer.Context time()
Returns a newTimer.Context
.- Returns:
- a new
Timer.Context
- See Also:
Timer.Context
-
getElapsedTime
Duration getElapsedTime()
Returns the total elapsed timing durations of all completed timing events that are recorded withupdate(Duration)
.- Returns:
- the elapsed time
duration
-
getCount
long getCount()
-
getSnapshot
Snapshot getSnapshot()
Description copied from interface:Sampling
Returns a snapshot of the values.- Specified by:
getSnapshot
in interfaceSampling
- Returns:
- a snapshot of the values
-
-