Clock (RxJava Javadoc 0.4.13)

java.lang.Object
- io.reactivex.netty.metrics.Clock

```
public class Clock
extends java.lang.Object
```
A simple utility to wrap start and end times of a call, typically used to give MetricEventsListener callbacks.
Thread Safety
This class is NOT threadsafe.
Memory overhead
One of the major concerns in publishing metric events is the object allocation overhead and having a Clock instance can attribute to such overheads. This is the reason why this class also provides static convenience methods to mark start and end of times to reduce some boiler plate code.

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`SYSTEM_TIME_DISABLED_TIME` The value returned by all static methods in this class, viz., `newStartTime(TimeUnit)` `newStartTimeMillis()` `onEndMillis(long)` `onEnd(long, TimeUnit)` after calling `disableSystemTimeCalls()`

Constructor Summary

Constructors
Constructor and Description

Clock()

Constructors
Constructor and Description
`Clock()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`disableSystemTimeCalls()` An optimization hook for low level benchmarks which will make any subsequent calls to `newStartTime(TimeUnit)` `newStartTimeMillis()` `onEndMillis(long)` `onEnd(long, TimeUnit)` will start returning `SYSTEM_TIME_DISABLED_TIME`.
`long`	`getDuration(java.util.concurrent.TimeUnit targetUnit)` Returns the duration for which this clock was running in the given timeunit.
`long`	`getDurationInMillis()` Returns the duration for which this clock was running in milliseconds.
`long`	`getStartTime(java.util.concurrent.TimeUnit targetUnit)`
`long`	`getStartTimeMillis()`
`boolean`	`isRunning()`
`static long`	`newStartTime(java.util.concurrent.TimeUnit timeUnit)`
`static long`	`newStartTimeMillis()`
`static long`	`onEnd(long startTime, java.util.concurrent.TimeUnit timeUnit)`
`static long`	`onEndMillis(long startTimeMillis)`
`long`	`stop()` Stops this clock.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SYSTEM_TIME_DISABLED_TIME
```
public static final long SYSTEM_TIME_DISABLED_TIME
```
    The value returned by all static methods in this class, viz.,
    after calling disableSystemTimeCalls()
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Clock
```
public Clock()
```
- Method Detail
  - stop
```
public long stop()
```
    Stops this clock. This method is idempotent, so, after invoking this method, the duration of the clock is immutable. Hence, you can call this method multiple times with no side-effects.
    
    Returns:
    
    The duration in milliseconds for which the clock was running.
  - getStartTimeMillis
```
public long getStartTimeMillis()
```
  - getStartTime
```
public long getStartTime(java.util.concurrent.TimeUnit targetUnit)
```
  - getDurationInMillis
```
public long getDurationInMillis()
```
    Returns the duration for which this clock was running in milliseconds.
    
    Returns:
    
    The duration for which this clock was running in milliseconds.
    
    Throws:
    
    java.lang.IllegalStateException - If the clock is not yet stopped.
  - getDuration
```
public long getDuration(java.util.concurrent.TimeUnit targetUnit)
```
    Returns the duration for which this clock was running in the given timeunit.
    
    Returns:
    
    The duration for which this clock was running in the given timeunit.
    
    Throws:
    
    java.lang.IllegalStateException - If the clock is not yet stopped.
  - isRunning
```
public boolean isRunning()
```
  - disableSystemTimeCalls
```
public static void disableSystemTimeCalls()
```
    An optimization hook for low level benchmarks which will make any subsequent calls to
    will start returning SYSTEM_TIME_DISABLED_TIME. This essentially means that instead of calling System.currentTimeMillis() these methods will use SYSTEM_TIME_DISABLED_TIME
  - newStartTimeMillis
```
public static long newStartTimeMillis()
```
  - newStartTime
```
public static long newStartTime(java.util.concurrent.TimeUnit timeUnit)
```
  - onEnd
```
public static long onEnd(long startTime,
                         java.util.concurrent.TimeUnit timeUnit)
```
  - onEndMillis
```
public static long onEndMillis(long startTimeMillis)
```

RxJava

Class Clock

Thread Safety

Memory overhead

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SYSTEM_TIME_DISABLED_TIME

Constructor Detail

Clock

Method Detail

stop

getStartTimeMillis

getStartTime

getDurationInMillis

getDuration

isRunning

disableSystemTimeCalls

newStartTimeMillis

newStartTime

onEnd

onEndMillis