com.yahoo.bard.webservice.logging

Class TimedPhase

java.lang.Object

com.yahoo.bard.webservice.logging.TimedPhase

All Implemented Interfaces:

AutoCloseable

public class TimedPhase
extends Object
implements AutoCloseable

Represents a phase that is timed. TimedPhase is used to associate a Timer located in the registry with the exact duration of such a phase for a specific request. Times are in nanoseconds.

Note: This class is NOT thread-safe. Timers are intended to be started once by one thread, and stopped once by one thread (though those threads are not necessarily the same).

Constructor Summary

Constructors

Constructor and Description
TimedPhase(String name) Constructor.

Method Summary

Modifier and Type	Method and Description
void	close() Stops the timer, and registers the timer with the RequestLog.
long	getDuration() Return the duration of the timer in nanoseconds.
String	getName()
TimeUnit	getUnit()
boolean	isRunning()
void	registerTime() Registers the duration of this timer with the RequestLog.
TimedPhase	start() Start the phase.
void	stop() Stop the phase.

Methods inherited from class java.lang.Object

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

Constructor Detail

TimedPhase

public TimedPhase(String name)

Constructor.

Parameters:

name - Name of the phase

Method Detail

start

public TimedPhase start()

Start the phase.

Returns:

This phase after being started

stop

public void stop()

Stop the phase.

This method just stops the timer. It does not register the time with the RequestLog. To register the timer, invoke registerTime(). To do both with a single method call, see close()

See Also:

registerTime(), close()

registerTime

public void registerTime()

Registers the duration of this timer with the RequestLog.

It is highly recommended that you stop()} the timer first. Otherwise, the timings may be inaccurate. To both stop and register the timer at once see close().

See Also:

stop(), close()

getDuration

public long getDuration()

Return the duration of the timer in nanoseconds.

Returns:

The duration of the timer in nanoseconds

getName

public String getName()

getUnit

public TimeUnit getUnit()

isRunning

public boolean isRunning()

close

public void close()

Stops the timer, and registers the timer with the RequestLog.

This is primarily meant to be used by the try-with-resources block, which both stops the timer and registers it with the RequestLog, though it can of course be called manually as well. If you want to stop the timer, but don't want to register the timer just yet, then see stop().

Specified by:

close in interface AutoCloseable

See Also:

stop(), registerTime()