Ticker Type — netty Architecture

Source Code

common/src/main/java/io/netty/util/concurrent/Ticker.java lines 23–74

public interface Ticker {
    /**
     * Returns the singleton {@link Ticker} that returns the values from the real system clock source.
     * However, note that this is not the same as {@link System#nanoTime()} because we apply a fixed offset
     * to the {@link System#nanoTime() nanoTime}.
     */
    static Ticker systemTicker() {
        return SystemTicker.INSTANCE;
    }

    /**
     * Returns a newly created mock {@link Ticker} that allows the caller control the flow of time.
     * This can be useful when you test time-sensitive logic without waiting for too long or introducing
     * flakiness due to non-deterministic nature of system clock.
     */
    static MockTicker newMockTicker() {
        return new DefaultMockTicker();
    }

    /**
     * The initial value used for delay and computations based upon a monotonic time source.
     * @return initial value used for delay and computations based upon a monotonic time source.
     */
    long initialNanoTime();

    /**
     * The time elapsed since initialization of this class in nanoseconds. This may return a negative number just like
     * {@link System#nanoTime()}.
     */
    long nanoTime();

    /**
     * Waits until the given amount of time goes by.
     *
     * @param delay the amount of delay.
     * @param unit the {@link TimeUnit} of {@code delay}.
     *
     * @see Thread#sleep(long)
     */
    void sleep(long delay, TimeUnit unit) throws InterruptedException;

    /**
     * Waits until the given amount of time goes by.
     *
     * @param delayMillis the number of milliseconds.
     *
     * @see Thread#sleep(long)
     */
    default void sleepMillis(long delayMillis) throws InterruptedException {
        sleep(delayMillis, TimeUnit.MILLISECONDS);
    }
}