1 /*
2 * Copyright 2025 The Netty Project
3 *
4 * The Netty Project licenses this file to you under the Apache License,
5 * version 2.0 (the "License"); you may not use this file except in compliance
6 * with the License. You may obtain a copy of the License at:
7 *
8 * https://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
12 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
13 * License for the specific language governing permissions and limitations
14 * under the License.
15 */
16 package io.netty.util.concurrent;
17
18 import java.util.concurrent.TimeUnit;
19
20 /**
21 * A fake {@link Ticker} that allows the caller control the flow of time.
22 * This can be useful when you test time-sensitive logic without waiting for too long
23 * or introducing flakiness due to non-deterministic nature of system clock.
24 */
25 public interface MockTicker extends Ticker {
26
27 @Override
28 default long initialNanoTime() {
29 return 0;
30 }
31
32 /**
33 * Advances the current {@link #nanoTime()} by the given amount of time.
34 *
35 * @param amount the amount of time to advance this ticker by.
36 * @param unit the {@link TimeUnit} of {@code amount}.
37 */
38 void advance(long amount, TimeUnit unit);
39
40 /**
41 * Advances the current {@link #nanoTime()} by the given amount of time.
42 *
43 * @param amountMillis the number of milliseconds to advance this ticker by.
44 */
45 default void advanceMillis(long amountMillis) {
46 advance(amountMillis, TimeUnit.MILLISECONDS);
47 }
48 }