QuickTickLib 1.2.0

QuickTick

QuickTick is a high-precision timer library for .NET 8.0 and .NET Framework 4.8, designed for scenarios where accurate and low-latency timing is required.

It is inspired by discussions in the .NET Runtime issue #67088 and is based on the high-resolution timer implemented by Microsoft's Go team, as detailed in this blog post.

QuickTick leverages IO Completion Ports (IOCP) and NT system calls on windows to achieve precise and efficient timing without needing to fiddle with the system clock rate. It enables the creation of a Timer and the use of Sleep and Delay functions with precision below 15.6 ms, ensuring accurate timing without impacting other parts of your application. QuickTick only really has an effect when used on a windows systems. On most other platforms supported by .NET 8.0 you dont really need a more precise timer, as systems like linux dont have the 15.6 ms limitation from the start. To allow the usage of QuickTick in cross-platform projects it automatically falls back to the base .net functions on all platforms that are not Windows (10 or higher).

QuickTickTimer Class

Definition

Namespace: QuickTickLib

Provides a high-resolution timer using IO Completion Ports (IOCP) and NtAssociateWaitCompletionPacket for precise timing events under windows. Similar in use to the System.Timers.Timer class.

public class QuickTickTimer : IDisposable

Inheritance Object → QuickTickTimer

Implements IDisposable

Example Usage

The following example shows the usage of the QuickTickTimer with an interval of 500ms.

using QuickTickLib;

class Program
{
    static void Main()
    {
        using QuickTickTimer timer = new QuickTickTimer(500);
        timer.AutoReset = true;
        timer.Elapsed += Timer_Elapsed;
        timer.Start();

        Thread.Sleep(5000); // Run for 5 seconds
        timer.Stop();
    }

    private static void Timer_Elapsed(object sender, QuickTickElapsedEventArgs e)
    {
        Console.WriteLine($"Timer elapsed! Scheduled: {e.ScheduledTime:dd.MM.yyyy HH:mm:ss.fff}, Actual: {e.SignalTime:dd.MM.yyyy HH:mm:ss.fff}");
    }
}

// The example displays output like the following:
    // Timer elapsed! Scheduled: 05.03.2025 18:52:21.120, Actual: 05.03.2025 18:52:21.121
    // Timer elapsed! Scheduled: 05.03.2025 18:52:21.620, Actual: 05.03.2025 18:52:21.620
    // Timer elapsed! Scheduled: 05.03.2025 18:52:22.120, Actual: 05.03.2025 18:52:22.120
    // Timer elapsed! Scheduled: 05.03.2025 18:52:22.620, Actual: 05.03.2025 18:52:22.622
    // Timer elapsed! Scheduled: 05.03.2025 18:52:23.120, Actual: 05.03.2025 18:52:23.121
    // Timer elapsed! Scheduled: 05.03.2025 18:52:23.620, Actual: 05.03.2025 18:52:23.620
    // Timer elapsed! Scheduled: 05.03.2025 18:52:24.120, Actual: 05.03.2025 18:52:24.121
    // Timer elapsed! Scheduled: 05.03.2025 18:52:24.620, Actual: 05.03.2025 18:52:24.620
    // Timer elapsed! Scheduled: 05.03.2025 18:52:25.120, Actual: 05.03.2025 18:52:25.120
    // Timer elapsed! Scheduled: 05.03.2025 18:52:25.620, Actual: 05.03.2025 18:52:25.621

Remarks

QuickTickTimer is a timer based on IO Completion Ports for high-precision timing. Using the windows function NtAssociateWaitCompletionPacket it can go below the default windows timer resolution of 15.6ms without needing to set the system clock rate using TimeBeginPeriod. The timer therefore has no influence on the remaining program and calls like Thread.Sleep or Task.Delay are not affected.

This class implements the IDisposable interface. When you are finished using the timer, you should dispose of it to release all associated resources.

Constructors

QuickTickTimer(double interval)

public QuickTickTimer(double interval)

Initializes a new instance of the QuickTickTimer class with the specified interval in milliseconds.

Parameters

• interval (Double): The timer interval in milliseconds.

Exceptions

• ArgumentOutOfRangeException: Thrown if interval is outside the valid range:
  • For QuickTick: must be ≥ 0.5 milliseconds and ≤ int.MaxValue milliseconds
  • For Fallback: must be ≥ 1 millisecond and ≤ int.MaxValue milliseconds
• InvalidOperationException: Thrown if system API calls fail during initialization.

QuickTickTimer(TimeSpan interval)

public QuickTickTimer(TimeSpan interval)

Initializes a new instance of the QuickTickTimer class with the specified interval as a TimeSpan. Be aware that using TimeSpan.FromMilliseconds() allready rounds to full milliseconds so if you want tp create a timer with sub millisecond timing you would need to create the timeSpan with TimeSpan.FromMicroseconds()

Parameters

• interval (TimeSpan): The timer interval.

Exceptions

• ArgumentOutOfRangeException: Thrown if interval is outside the valid range:
  • For QuickTick: must be ≥ 0.5 milliseconds and ≤ int.MaxValue milliseconds
  • For Fallback: must be ≥ 1 millisecond and ≤ int.MaxValue milliseconds
• InvalidOperationException: Thrown if system API calls fail during initialization.

Properties

IsQuickTickUsed

public bool IsQuickTickUsed { get; }

Gets a value indicating whether the high-resolution QuickTick implementation is being used.

When true, the timer is backed by the QuickTickTimerImplementation, which offers higher precision and lower latency on windows. When false, the platform does not support QuickTick, and the timer falls back to the QuickTickTimerFallback implementation.

Interval

public double Interval { get; set; }

Gets or sets the time, in milliseconds, between timer events.

Exceptions

• ArgumentOutOfRangeException: Thrown if value is outside the valid range:
  • For QuickTick: must be ≥ 0.5 milliseconds and ≤ int.MaxValue milliseconds
  • For Fallback: must be ≥ 1 millisecond and ≤ int.MaxValue milliseconds

AutoReset

public bool AutoReset { get; set; }

Gets or sets whether the timer should restart after each elapsed event. Default is true.

• true: The timer restarts automatically.
• false: The timer stops after firing once.

Methods

Start()

public void Start()

Starts the timer.

Exceptions

• InvalidOperationException: Thrown if system API calls fail when setting the timer.

Stop()

public void Stop()

Stops the timer if it is currently running.

Dispose()

public void Dispose()

Stops the timer and releases all associated system resources.

Events

Elapsed

public event QuickTickElapsedEventHandler Elapsed;

Occurs when the timer interval has elapsed.

Event Arguments

• QuickTickElapsedEventArgs: Contains information about the scheduled and actual firing times.
  • SignalTime (DateTime): The actual time when the event was triggered. The time is a UTC-Timestamp.
  • ScheduledTime (DateTime): The originally scheduled time for the timer event. The time is a UTC-Timestamp.

QuickTickTiming Class

Definition

Namespace: QuickTickLib

Provides sleep and delay functions with high precision using IO Completion Ports (IOCP) and NtAssociateWaitCompletionPacket for precise timing events under windows. Running under different platforms it just falls back to the built in .net functions.

public static class QuickTickTiming

Inheritance Object → QuickTickTiming

Methods

Sleep()

public static void Sleep(int sleepTimeMs)

Blocks the current thread for the specified number of milliseconds. If the sleep time is less than or equal to 0ms, the function will behave the same as Thread.Sleep() will in this situation.

Exceptions

• InvalidOperationException: Thrown if system API calls fail during initialization.

Delay()

public static async Task Delay(int milliseconds, CancellationToken cancellationToken = default)
public static async Task Delay(TimeSpan timeSpan, CancellationToken cancellationToken = default)

Asynchronously blocks the current thread for the specified duration. It allows cancellation via the CancellationToken.

• milliseconds and timeSpan specify the delay time.
• If cancellationToken is triggered, the delay will be canceled early.

Exceptions

• ArgumentOutOfRangeException: Thrown if interval or timeSpan is less than or equal to zero.
• InvalidOperationException: Thrown if system API calls fail during initialization.