gui-cs.Terminal.Gui/Terminal.Gui/ConsoleDrivers/V2/IConsoleInput.cs

using System.Collections.Concurrent;

namespace Terminal.Gui;

/// <summary>
///     Interface for reading console input indefinitely -
///     i.e. in an infinite loop. The class is responsible only
///     for reading and storing the input in a thread safe input buffer
///     which is then processed downstream e.g. on main UI thread.
/// </summary>
/// <typeparam name="T"></typeparam>
public interface IConsoleInput<T> : IDisposable
{
    /// <summary>
    ///     Initializes the input with a buffer into which to put data read
    /// </summary>
    /// <param name="inputBuffer"></param>
    void Initialize (ConcurrentQueue<T> inputBuffer);

    /// <summary>
    ///     Runs in an infinite input loop.
    /// </summary>
    /// <param name="token"></param>
    /// <exception cref="OperationCanceledException">
    ///     Raised when token is
    ///     cancelled. This is the only means of exiting the input.
    /// </exception>
    void Run (CancellationToken token);
}