RaspberryIO_26/Swan.Lite/Threading/IWorker.cs

using System;
using System.Threading.Tasks;

namespace Swan.Threading {
  /// <summary>
  /// Defines a standard API to control background application workers.
  /// </summary>
  public interface IWorker {
    /// <summary>
    /// Gets the current state of the worker.
    /// </summary>
    WorkerState WorkerState {
      get;
    }

    /// <summary>
    /// Gets a value indicating whether this instance is disposed.
    /// </summary>
    /// <value>
    ///   <c>true</c> if this instance is disposed; otherwise, <c>false</c>.
    /// </value>
    Boolean IsDisposed {
      get;
    }

    /// <summary>
    /// Gets a value indicating whether this instance is currently being disposed.
    /// </summary>
    /// <value>
    ///   <c>true</c> if this instance is disposing; otherwise, <c>false</c>.
    /// </value>
    Boolean IsDisposing {
      get;
    }

    /// <summary>
    /// Gets or sets the time interval used to execute cycles.
    /// </summary>
    TimeSpan Period {
      get; set;
    }

    /// <summary>
    /// Gets the name identifier of this worker.
    /// </summary>
    String Name {
      get;
    }

    /// <summary>
    /// Starts execution of worker cycles.
    /// </summary>
    /// <returns>The awaitable task.</returns>
    Task<WorkerState> StartAsync();

    /// <summary>
    /// Pauses execution of worker cycles.
    /// </summary>
    /// <returns>The awaitable task.</returns>
    Task<WorkerState> PauseAsync();

    /// <summary>
    /// Resumes execution of worker cycles.
    /// </summary>
    /// <returns>The awaitable task.</returns>
    Task<WorkerState> ResumeAsync();

    /// <summary>
    /// Permanently stops execution of worker cycles.
    /// An interrupt is always sent to the worker. If you wish to stop
    /// the worker without interrupting then call the <see cref="PauseAsync"/>
    /// method, await it, and finally call the <see cref="StopAsync"/> method.
    /// </summary>
    /// <returns>The awaitable task.</returns>
    Task<WorkerState> StopAsync();
  }
}