SafeCounter.cs

namespace Searcher;

/// <summary>
/// This is a thread safe Int32 counter using Interlocked.Increment etc
/// </summary>
/// <remarks>
/// Create a new counter with an optional start value
/// </remarks>
internal sealed class SafeCounter(int counter = 0) // this class exists to wrap this field and prevent direct access
{
	/// <summary>
	/// Get the current value of the counter
	/// </summary>
	public int Value => counter;    // no need for Interlocked here, Int32 is atomic on both 32 and 64 bit

	/// <summary>
	/// Increment the counter in a thread safe way. Lock free
	/// </summary>
	/// <returns>The incremented value</returns>
	public int Increment() => Interlocked.Increment(ref counter);

	/// <summary>
	/// Decrement the counter in a thread safe way. Lock free
	/// </summary>
	/// <returns>The decremented value</returns>
	public int Decrement() => Interlocked.Decrement(ref counter);

	/// <summary>
	/// Reset the counter in a thread safe way. Lock free
	/// </summary>
	/// <returns>The original value</returns>
	public int Reset(int newvalue = 0) => Interlocked.Exchange(ref counter, newvalue);

	/// <summary>
	/// Add a value to the counter in a thread safe way. Lock free
	/// </summary>
	/// <returns>The new value</returns>
	public int Add(int value) => Interlocked.Add(ref counter, value);

	public override string ToString() => counter.ToString();
}