/**
* 来源:
* https://github.com/walterlv/sharing-demo/blob/master/src/Walterlv.Core/Threading/AwaiterInterfaces.cs
* 参考资料:
* https://weblogs.asp.net/dixin/understanding-c-sharp-async-await-2-awaitable-awaiter-pattern
* https://blog.walterlv.com/post/write-dispatcher-awaiter-for-ui.html#awaiter-%E7%B3%BB%E5%88%97%E6%96%87%E7%AB%A0
*
*/
using System.Runtime.CompilerServices;
namespace Fort23.Core
{
#region 可以被await的接口
///
/// 表示一个可等待对象,如果一个方法返回此类型的实例,则此方法可以使用 `await` 异步等待。
///
/// 用于给 await 确定返回时机的 IAwaiter 的实例。
public interface IAwaitable where TAwaiter : IAwaiter
{
///
/// 获取一个可用于 await 关键字异步等待的异步等待对象。
/// 此方法会被编译器自动调用。
///
TAwaiter GetAwaiter();
}
///
/// 表示一个包含返回值的可等待对象,如果一个方法返回此类型的实例,则此方法可以使用 `await` 异步等待返回值。
///
/// 用于给 await 确定返回时机的 IAwaiter{} 的实例。
/// 异步返回的返回值类型。
public interface IAwaitable where TAwaiter : IAwaiter
{
///
/// 获取一个可用于 await 关键字异步等待的异步等待对象。
/// 此方法会被编译器自动调用。
///
TAwaiter GetAwaiter();
}
#endregion
#region GetAwaiter()方法返回的类的接口定义
///
/// 用于给 await 确定异步返回的时机。
///
public interface IAwaiter : INotifyCompletion
{
///
/// 获取一个状态,该状态表示正在异步等待的操作已经完成(成功完成或发生了异常);此状态会被编译器自动调用。
/// 在实现中,为了达到各种效果,可以灵活应用其值:可以始终为 true,或者始终为 false。
///
bool IsCompleted { get; }
///
/// 此方法会被编译器在 await 结束时自动调用以获取返回状态(包括异常)。
///
void GetResult();
}
///
/// 当执行关键代码(此代码中的错误可能给应用程序中的其他状态造成负面影响)时,
/// 用于给 await 确定异步返回的时机。
///
public interface ICriticalAwaiter : IAwaiter, ICriticalNotifyCompletion
{
}
///
/// 用于给 await 确定异步返回的时机,并获取到返回值。
///
/// 异步返回的返回值类型。
public interface IAwaiter : INotifyCompletion
{
///
/// 获取一个状态,该状态表示正在异步等待的操作已经完成(成功完成或发生了异常);此状态会被编译器自动调用。
/// 在实现中,为了达到各种效果,可以灵活应用其值:可以始终为 true,或者始终为 false。
///
bool IsCompleted { get; }
///
/// 获取此异步等待操作的返回值,此方法会被编译器在 await 结束时自动调用以获取返回值(包括异常)。
///
/// 异步操作的返回值。
TResult GetResult();
}
///
/// 当执行关键代码(此代码中的错误可能给应用程序中的其他状态造成负面影响)时,
/// 用于给 await 确定异步返回的时机,并获取到返回值。
///
/// 异步返回的返回值类型。
public interface ICriticalAwaiter : IAwaiter, ICriticalNotifyCompletion
{
}
#endregion
}