Files
UnrealEngineUWP/Engine/Source/Programs/Shared/EpicGames.Core/CancellationTask.cs
Ben Marsh 075162706e EpicGames.Core: Fix static analysis warnings.
#preflight 633b4ae16b10157eac6f1f15

[CL 22314153 by Ben Marsh in ue5-main branch]
2022-10-03 17:01:13 -04:00

48 lines
1.1 KiB
C#

// Copyright Epic Games, Inc. All Rights Reserved.
using System;
using System.Threading;
using System.Threading.Tasks;
namespace EpicGames.Core
{
/// <summary>
/// Wrapper class to create a waitable task out of a cancellation token
/// </summary>
public sealed class CancellationTask : IDisposable
{
/// <summary>
/// Completion source for the task
/// </summary>
readonly TaskCompletionSource<bool> _completionSource;
/// <summary>
/// Registration handle with the cancellation token
/// </summary>
readonly CancellationTokenRegistration _registration;
/// <summary>
/// Constructor
/// </summary>
/// <param name="token">The cancellation token to register with</param>
public CancellationTask(CancellationToken token)
{
_completionSource = new TaskCompletionSource<bool>();
_registration = token.Register(() => _completionSource.TrySetResult(true));
}
/// <summary>
/// The task that can be waited on
/// </summary>
public Task Task => _completionSource.Task;
/// <summary>
/// Dispose of any allocated resources
/// </summary>
public void Dispose()
{
_registration.Dispose();
}
}
}