Nuclex.Support/Source/Async/IProgressSource.cs

#region Apache License 2.0
/*
Nuclex .NET Framework
Copyright (C) 2002-2024 Markus Ewald / Nuclex Development Labs

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
#endregion // Apache License 2.0

using System;

namespace Nuclex.Support.Async {

  /// <summary>Provides progress reports for an <see cref="IAsyncTask" /></summary>
  public interface IProgressSource {

    /// <summary>Called when the asynchronous action has made progress</summary>
    event EventHandler ProgressUpdated;

    /// <summary>Current progress of the asynchronous action</summary>
    float Progress { get; }

  }

  /// <summary>Provides progress reports with a status message</summary>
  /// <typeparam name="TStatus">Type of status message the progress source provides</typeparam>
  public interface IProgressSource<TStatus> : IProgressSource {

    /// <summary>Current status of the asynchronous action</summary>
    TStatus Status { get; }

  }

} // namespace Nuclex.Support.Async