h1or4dme8/osu-lazer
1
0
Fork 0
mirror of https://github.com/ppy/osu.git synced 2025-01-13 07:22:54 +08:00
Code Issues Releases Wiki Activity

Comment and add xmldoc

Browse Source
This commit is contained in:
Dean Herbert 2021-01-27 20:01:21 +09:00
parent fcfb0d52c2
commit a30aecbafe
2 changed files with 24 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
osu.Game.Tests/NonVisual/TaskChainTest.cs
View File

@ -6,7 +6,6 @@ using System.Threading;
using System.Threading.Tasks; using System.Threading.Tasks;
using NUnit.Framework; using NUnit.Framework;
using osu.Game.Extensions; using osu.Game.Extensions;
using osu.Game.Utils;
namespace osu.Game.Tests.NonVisual namespace osu.Game.Tests.NonVisual
{ {

32
osu.Game/Extensions/TaskExtensions.cs
View File

@ -34,32 +34,46 @@ namespace osu.Game.Extensions
}, TaskContinuationOptions.NotOnRanToCompletion); }, TaskContinuationOptions.NotOnRanToCompletion);
} }
public static Task ContinueWithSequential(this Task task, Action continuationFunction, CancellationToken cancellationToken = default) /// <summary>
{ /// Add a continuation to be performed only after the attached task has completed.
return task.ContinueWithSequential(() => Task.Run(continuationFunction, cancellationToken), cancellationToken); /// </summary>
} /// <param name="task">The previous task to be awaited on.</param>
/// <param name="action">The action to run.</param>
/// <param name="cancellationToken">An optional cancellation token. Will only cancel the provided action, not the sequence.</param>
/// <returns>A task representing the provided action.</returns>
public static Task ContinueWithSequential(this Task task, Action action, CancellationToken cancellationToken = default) =>
task.ContinueWithSequential(() => Task.Run(action, cancellationToken), cancellationToken);
/// <summary>
/// Add a continuation to be performed only after the attached task has completed.
/// </summary>
/// <param name="task">The previous task to be awaited on.</param>
/// <param name="continuationFunction">The continuation to run. Generally should be an async function.</param>
/// <param name="cancellationToken">An optional cancellation token. Will only cancel the provided action, not the sequence.</param>
/// <returns>A task representing the provided action.</returns>
public static Task ContinueWithSequential(this Task task, Func<Task> continuationFunction, CancellationToken cancellationToken = default) public static Task ContinueWithSequential(this Task task, Func<Task> continuationFunction, CancellationToken cancellationToken = default)
{ {
var tcs = new TaskCompletionSource<bool>(); var tcs = new TaskCompletionSource<bool>();
task.ContinueWith(t => task.ContinueWith(t =>
{ {
// the previous task has finished execution or been cancelled, so we can run the provided continuation.
if (cancellationToken.IsCancellationRequested) if (cancellationToken.IsCancellationRequested)
{ {
tcs.SetCanceled(); tcs.SetCanceled();
} }
else else
{ {
continuationFunction().ContinueWith(t2 => continuationFunction().ContinueWith(continuationTask =>
{ {
if (cancellationToken.IsCancellationRequested || t2.IsCanceled) if (cancellationToken.IsCancellationRequested || continuationTask.IsCanceled)
{ {
tcs.TrySetCanceled(); tcs.TrySetCanceled();
} }
else if (t2.IsFaulted) else if (continuationTask.IsFaulted)
{ {
tcs.TrySetException(t2.Exception); tcs.TrySetException(continuationTask.Exception);
} }
else else
{ {
@ -69,6 +83,8 @@ namespace osu.Game.Extensions
} }
}, cancellationToken: default); }, cancellationToken: default);
// importantly, we are not returning the continuation itself but rather a task which represents its status in sequential execution order.
// this will not be cancelled or completed until the previous task has also.
return tcs.Task; return tcs.Task;
} }
} }