网上演练
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

420 lines
18 KiB

#if NET20 || NET30 || NET35 || NET40 || !NET_4_6
using System.Diagnostics;
using System.Security;
using System.Threading.Tasks;
namespace System.Runtime.CompilerServices
{
/// <summary>
/// Provides a builder for asynchronous methods that return <see cref="T:System.Threading.Tasks.Task"/>.
/// This type is intended for compiler use only.
///
/// </summary>
///
/// <remarks>
/// AsyncTaskMethodBuilder is a value type, and thus it is copied by value.
/// Prior to being copied, one of its Task, SetResult, or SetException members must be accessed,
/// or else the copies may end up building distinct Task instances.
///
/// </remarks>
public struct AsyncTaskMethodBuilder : IAsyncMethodBuilder
{
/// <summary>
/// A cached VoidTaskResult task used for builders that complete synchronously.
/// </summary>
private static readonly TaskCompletionSource<VoidTaskResult> _cachedCompleted = AsyncTaskMethodBuilder<VoidTaskResult>._defaultResultTask;
/// <summary>
/// The generic builder object to which this non-generic instance delegates.
/// </summary>
private AsyncTaskMethodBuilder<VoidTaskResult> _builder;
/// <summary>
/// Gets the <see cref="T:System.Threading.Tasks.Task"/> for this builder.
/// </summary>
///
/// <returns>
/// The <see cref="T:System.Threading.Tasks.Task"/> representing the builder's asynchronous operation.
/// </returns>
/// <exception cref="T:System.InvalidOperationException">The builder is not initialized.</exception>
public Task Task
{
get { return _builder.Task; }
}
/// <summary>
/// Gets an object that may be used to uniquely identify this builder to the debugger.
///
/// </summary>
///
/// <remarks>
/// This property lazily instantiates the ID in a non-thread-safe manner.
/// It must only be used by the debugger, and only in a single-threaded manner
/// when no other threads are in the middle of accessing this property or this.Task.
///
/// </remarks>
private object ObjectIdForDebugger
{
get { return Task; }
}
/// <summary>
/// Initializes a new <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder"/>.
/// </summary>
///
/// <returns>
/// The initialized <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder"/>.
/// </returns>
public static AsyncTaskMethodBuilder Create()
{
return new AsyncTaskMethodBuilder();
}
/// <summary>
/// Initiates the builder's execution with the associated state machine.
/// </summary>
/// <typeparam name="TStateMachine">Specifies the type of the state machine.</typeparam><param name="stateMachine">The state machine instance, passed by reference.</param>
[DebuggerStepThrough]
public void Start<TStateMachine>(ref TStateMachine stateMachine) where TStateMachine : IAsyncStateMachine
{
_builder.Start(ref stateMachine);
}
/// <summary>
/// Associates the builder with the state machine it represents.
/// </summary>
/// <param name="stateMachine">The heap-allocated state machine object.</param><exception cref="T:System.ArgumentNullException">The <paramref name="stateMachine"/> argument was null (Nothing in Visual Basic).</exception><exception cref="T:System.InvalidOperationException">The builder is incorrectly initialized.</exception>
public void SetStateMachine(IAsyncStateMachine stateMachine)
{
_builder.SetStateMachine(stateMachine);
}
void IAsyncMethodBuilder.PreBoxInitialization()
{
GC.KeepAlive(Task);
}
/// <summary>
/// Schedules the specified state machine to be pushed forward when the specified awaiter completes.
///
/// </summary>
/// <typeparam name="TAwaiter">Specifies the type of the awaiter.</typeparam><typeparam name="TStateMachine">Specifies the type of the state machine.</typeparam><param name="awaiter">The awaiter.</param><param name="stateMachine">The state machine.</param>
public void AwaitOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine)
where TAwaiter : INotifyCompletion
where TStateMachine : IAsyncStateMachine
{
_builder.AwaitOnCompleted(ref awaiter, ref stateMachine);
}
/// <summary>
/// Schedules the specified state machine to be pushed forward when the specified awaiter completes.
///
/// </summary>
/// <typeparam name="TAwaiter">Specifies the type of the awaiter.</typeparam><typeparam name="TStateMachine">Specifies the type of the state machine.</typeparam><param name="awaiter">The awaiter.</param><param name="stateMachine">The state machine.</param>
public void AwaitUnsafeOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine)
where TAwaiter : ICriticalNotifyCompletion
where TStateMachine : IAsyncStateMachine
{
_builder.AwaitUnsafeOnCompleted(ref awaiter, ref stateMachine);
}
/// <summary>
/// Completes the <see cref="T:System.Threading.Tasks.Task"/> in the
/// <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state.
///
/// </summary>
/// <exception cref="T:System.InvalidOperationException">The builder is not initialized.</exception><exception cref="T:System.InvalidOperationException">The task has already completed.</exception>
public void SetResult()
{
_builder.SetResult(_cachedCompleted);
}
/// <summary>
/// Completes the <see cref="T:System.Threading.Tasks.Task"/> in the
/// <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state with the specified exception.
///
/// </summary>
/// <param name="exception">The <see cref="T:System.Exception"/> to use to fault the task.</param><exception cref="T:System.ArgumentNullException">The <paramref name="exception"/> argument is null (Nothing in Visual Basic).</exception><exception cref="T:System.InvalidOperationException">The builder is not initialized.</exception><exception cref="T:System.InvalidOperationException">The task has already completed.</exception>
public void SetException(Exception exception)
{
_builder.SetException(exception);
}
/// <summary>
/// Called by the debugger to request notification when the first wait operation
/// (await, Wait, Result, etc.) on this builder's task completes.
///
/// </summary>
/// <param name="enabled">true to enable notification; false to disable a previously set notification.
/// </param>
internal void SetNotificationForWaitCompletion(bool enabled)
{
_builder.SetNotificationForWaitCompletion(enabled);
}
}
/// <summary>
/// Provides a builder for asynchronous methods that return <see cref="T:System.Threading.Tasks.Task`1"/>.
/// This type is intended for compiler use only.
///
/// </summary>
///
/// <remarks>
/// AsyncTaskMethodBuilder{TResult} is a value type, and thus it is copied by value.
/// Prior to being copied, one of its Task, SetResult, or SetException members must be accessed,
/// or else the copies may end up building distinct Task instances.
///
/// </remarks>
public struct AsyncTaskMethodBuilder<TResult> : IAsyncMethodBuilder
{
/// <summary>
/// A cached task for default(TResult).
/// </summary>
internal static readonly TaskCompletionSource<TResult> _defaultResultTask = AsyncMethodTaskCache<TResult>.CreateCompleted(default(TResult));
/// <summary>
/// State related to the IAsyncStateMachine.
/// </summary>
private AsyncMethodBuilderCore _coreState;
/// <summary>
/// The lazily-initialized task completion source.
/// </summary>
private TaskCompletionSource<TResult> _task;
/// <summary>
/// Gets the lazily-initialized TaskCompletionSource.
/// </summary>
internal TaskCompletionSource<TResult> CompletionSource
{
get
{
var completionSource = _task;
if (completionSource == null)
{
_task = completionSource = new TaskCompletionSource<TResult>();
}
return completionSource;
}
}
/// <summary>
/// Gets the <see cref="T:System.Threading.Tasks.Task`1"/> for this builder.
/// </summary>
///
/// <returns>
/// The <see cref="T:System.Threading.Tasks.Task`1"/> representing the builder's asynchronous operation.
/// </returns>
public Task<TResult> Task
{
get { return CompletionSource.Task; }
}
/// <summary>
/// Gets an object that may be used to uniquely identify this builder to the debugger.
///
/// </summary>
///
/// <remarks>
/// This property lazily instantiates the ID in a non-thread-safe manner.
/// It must only be used by the debugger, and only in a single-threaded manner
/// when no other threads are in the middle of accessing this property or this.Task.
///
/// </remarks>
private object ObjectIdForDebugger
{
get { return Task; }
}
/// <summary>
/// Temporary support for disabling crashing if tasks go unobserved.
/// </summary>
static AsyncTaskMethodBuilder()
{
try
{
AsyncVoidMethodBuilder.PreventUnobservedTaskExceptions();
}
catch (Exception ex)
{
GC.KeepAlive(ex);
}
}
/// <summary>
/// Initializes a new <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder"/>.
/// </summary>
///
/// <returns>
/// The initialized <see cref="T:System.Runtime.CompilerServices.AsyncTaskMethodBuilder"/>.
/// </returns>
public static AsyncTaskMethodBuilder<TResult> Create()
{
return new AsyncTaskMethodBuilder<TResult>();
}
/// <summary>
/// Initiates the builder's execution with the associated state machine.
/// </summary>
/// <typeparam name="TStateMachine">Specifies the type of the state machine.</typeparam><param name="stateMachine">The state machine instance, passed by reference.</param>
[DebuggerStepThrough]
public void Start<TStateMachine>(ref TStateMachine stateMachine) where TStateMachine : IAsyncStateMachine
{
_coreState.Start(ref stateMachine);
}
/// <summary>
/// Associates the builder with the state machine it represents.
/// </summary>
/// <param name="stateMachine">The heap-allocated state machine object.</param><exception cref="T:System.ArgumentNullException">The <paramref name="stateMachine"/> argument was null (Nothing in Visual Basic).</exception><exception cref="T:System.InvalidOperationException">The builder is incorrectly initialized.</exception>
public void SetStateMachine(IAsyncStateMachine stateMachine)
{
_coreState.SetStateMachine(stateMachine);
}
void IAsyncMethodBuilder.PreBoxInitialization()
{
GC.KeepAlive(Task);
}
/// <summary>
/// Schedules the specified state machine to be pushed forward when the specified awaiter completes.
///
/// </summary>
/// <typeparam name="TAwaiter">Specifies the type of the awaiter.</typeparam><typeparam name="TStateMachine">Specifies the type of the state machine.</typeparam><param name="awaiter">The awaiter.</param><param name="stateMachine">The state machine.</param>
public void AwaitOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine)
where TAwaiter : INotifyCompletion
where TStateMachine : IAsyncStateMachine
{
try
{
var completionAction = _coreState.GetCompletionAction(ref this, ref stateMachine);
awaiter.OnCompleted(completionAction);
}
catch (Exception ex)
{
AsyncMethodBuilderCore.ThrowOnContext(ex, null);
}
}
/// <summary>
/// Schedules the specified state machine to be pushed forward when the specified awaiter completes.
///
/// </summary>
/// <typeparam name="TAwaiter">Specifies the type of the awaiter.</typeparam><typeparam name="TStateMachine">Specifies the type of the state machine.</typeparam><param name="awaiter">The awaiter.</param><param name="stateMachine">The state machine.</param>
[SecuritySafeCritical]
public void AwaitUnsafeOnCompleted<TAwaiter, TStateMachine>(ref TAwaiter awaiter, ref TStateMachine stateMachine)
where TAwaiter : ICriticalNotifyCompletion
where TStateMachine : IAsyncStateMachine
{
try
{
var completionAction = _coreState.GetCompletionAction(ref this, ref stateMachine);
awaiter.UnsafeOnCompleted(completionAction);
}
catch (Exception ex)
{
AsyncMethodBuilderCore.ThrowOnContext(ex, null);
}
}
/// <summary>
/// Completes the <see cref="T:System.Threading.Tasks.Task`1"/> in the
/// <see cref="T:System.Threading.Tasks.TaskStatus">RanToCompletion</see> state with the specified result.
///
/// </summary>
/// <param name="result">The result to use to complete the task.</param><exception cref="T:System.InvalidOperationException">The task has already completed.</exception>
public void SetResult(TResult result)
{
var completionSource = _task;
if (completionSource == null)
{
_task = GetTaskForResult(result);
}
else if (!completionSource.TrySetResult(result))
{
throw new InvalidOperationException("The Task was already completed.");
}
}
/// <summary>
/// Completes the builder by using either the supplied completed task, or by completing
/// the builder's previously accessed task using default(TResult).
///
/// </summary>
/// <param name="completedTask">A task already completed with the value default(TResult).</param><exception cref="T:System.InvalidOperationException">The task has already completed.</exception>
internal void SetResult(TaskCompletionSource<TResult> completedTask)
{
if (_task == null)
{
_task = completedTask;
}
else
{
SetResult(default(TResult));
}
}
/// <summary>
/// Completes the <see cref="T:System.Threading.Tasks.Task`1"/> in the
/// <see cref="T:System.Threading.Tasks.TaskStatus">Faulted</see> state with the specified exception.
///
/// </summary>
/// <param name="exception">The <see cref="T:System.Exception"/> to use to fault the task.</param><exception cref="T:System.ArgumentNullException">The <paramref name="exception"/> argument is null (Nothing in Visual Basic).</exception><exception cref="T:System.InvalidOperationException">The task has already completed.</exception>
public void SetException(Exception exception)
{
if (exception == null)
{
throw new ArgumentNullException("exception");
}
var completionSource = CompletionSource;
var setException = (exception is OperationCanceledException ? completionSource.TrySetCanceled() : completionSource.TrySetException(exception));
if (!setException)
{
throw new InvalidOperationException("The Task was already completed.");
}
}
/// <summary>
/// Called by the debugger to request notification when the first wait operation
/// (await, Wait, Result, etc.) on this builder's task completes.
///
/// </summary>
/// <param name="enabled">true to enable notification; false to disable a previously set notification.
/// </param>
/// <remarks>
/// This should only be invoked from within an asynchronous method,
/// and only by the debugger.
///
/// </remarks>
internal void SetNotificationForWaitCompletion(bool enabled)
{
GC.KeepAlive(enabled);
}
/// <summary>
/// Gets a task for the specified result. This will either
/// be a cached or new task, never null.
///
/// </summary>
/// <param name="result">The result for which we need a task.</param>
/// <returns>
/// The completed task containing the result.
/// </returns>
private TaskCompletionSource<TResult> GetTaskForResult(TResult result)
{
var asyncMethodTaskCache = AsyncMethodTaskCache<TResult>.Singleton;
if (asyncMethodTaskCache == null)
{
return AsyncMethodTaskCache<TResult>.CreateCompleted(result);
}
return asyncMethodTaskCache.FromResult(result);
}
}
}
#endif