io.reactivex.netty.events

Class Clock

java.lang.Object

io.reactivex.netty.events.Clock

public class Clock
extends java.lang.Object

A simple utility to wrap start and end times of a call.

Thread Safety

This class is NOT threadsafe.

Memory overhead

One of the major concerns in publishing 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) newStartTimeNanos() onEndNanos(long) onEnd(long, TimeUnit) after calling RxNetty.disableEventPublishing()

Constructor Summary

Constructors

Constructor and Description
Clock()

Method Summary

Modifier and Type	Method and Description
long	getDuration(java.util.concurrent.TimeUnit targetUnit) Returns the duration for which this clock was running in the given timeunit.
long	getDurationInNanos() Returns the duration for which this clock was running in nanoseconds.
long	getStartTime(java.util.concurrent.TimeUnit targetUnit)
long	getStartTimeNanos()
boolean	isRunning()
static long	newStartTime(java.util.concurrent.TimeUnit timeUnit)
static long	newStartTimeNanos()
static long	onEnd(long startTime, java.util.concurrent.TimeUnit timeUnit)
static long	onEndNanos(long startTimeNanos)
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.,

• newStartTime(TimeUnit)
• newStartTimeNanos()
• onEndNanos(long)
• onEnd(long, TimeUnit)

after calling RxNetty.disableEventPublishing()

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 nanoseconds for which the clock was running.

getStartTimeNanos

public long getStartTimeNanos()

getStartTime

public long getStartTime(java.util.concurrent.TimeUnit targetUnit)

getDurationInNanos

public long getDurationInNanos()

Returns the duration for which this clock was running in nanoseconds.

Returns:

The duration for which this clock was running in nanoseconds.

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()

newStartTimeNanos

public static long newStartTimeNanos()

newStartTime

public static long newStartTime(java.util.concurrent.TimeUnit timeUnit)

onEnd

public static long onEnd(long startTime,
                         java.util.concurrent.TimeUnit timeUnit)

onEndNanos

public static long onEndNanos(long startTimeNanos)