oliverbooth/X10D
oliverbooth/X10D
1
0
Fork 0
mirror of https://github.com/oliverbooth/X10D synced 2024-11-09 23:25:43 +00:00
Code Issues

Remove WaitHandle.WaitOneAsync

Browse Source
This commit is contained in:
Oliver Booth 2022-04-26 10:22:26 +01:00
parent 40a75e62c0
commit 6580cd6e83
No known key found for this signature in database
GPG Key ID: 32A00B35503AF634
1 changed files with 0 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
X10D/src/Threading/WaitHandleExtensions.cs
View File

@ -1,31 +0,0 @@
namespace X10D.Threading;
/// <summary>
/// Threading-related extension methods for <see cref="WaitHandle" />.
/// </summary>
public static class WaitHandleExtensions
{
/// <summary>
/// Returns a <see cref="Task" /> which can be awaited until the current <see cref="WaitHandle" /> receives a signal.
/// </summary>
/// <param name="handle">The <see cref="WaitHandle" /> instance.</param>
/// <returns>
/// <see langword="true" /> if the current instance receives a signal. If the current instance is never signaled,
/// <see cref="WaitOneAsync" /> never returns.
/// </returns>
/// <remarks>
/// It is heavily recommended that the use of this method is minimal, or non-existent. For suspension of execution when
/// performing an asynchronous operation, use <see cref="TaskCompletionSource" /> or
/// <see cref="TaskCompletionSource{TResult}" />.
/// </remarks>
[Obsolete("Consider using a TaskCompletionSource instead.")]
public static Task<bool> WaitOneAsync(this WaitHandle handle)
{
if (handle is null)
{
throw new ArgumentNullException(nameof(handle));
}
return Task.Run(handle.WaitOne);
}
}