91 lines
3.8 KiB
C#
91 lines
3.8 KiB
C#
// Licensed to the .NET Foundation under one or more agreements.
|
|
// The .NET Foundation licenses this file to you under the MIT License.
|
|
// See the LICENSE file in the project root for more information.
|
|
|
|
using System.ComponentModel;
|
|
using System.Reactive.PlatformServices;
|
|
|
|
namespace System.Reactive.Concurrency
|
|
{
|
|
/// <summary>
|
|
/// (Infrastructure) Concurrency abstraction layer.
|
|
/// </summary>
|
|
internal static class ConcurrencyAbstractionLayer
|
|
{
|
|
/// <summary>
|
|
/// Gets the current CAL. If no CAL has been set yet, it will be initialized to the default.
|
|
/// </summary>
|
|
public static IConcurrencyAbstractionLayer Current { get; } = Initialize();
|
|
|
|
private static IConcurrencyAbstractionLayer Initialize()
|
|
{
|
|
//
|
|
// NB: For compat reasons, we allow null to leak here. Bad things will happen but we don't want
|
|
// to trigger an exception earlier than we did before. The only case where this can happen
|
|
// is when a custom PEP is installed, which is very rare (e.g. debugger, service hosting).
|
|
//
|
|
return PlatformEnlightenmentProvider.Current.GetService<IConcurrencyAbstractionLayer>()!;
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// (Infrastructure) Concurrency abstraction layer interface.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// This type is used by the Rx infrastructure and not meant for public consumption or implementation.
|
|
/// No guarantees are made about forward compatibility of the type's functionality and its usage.
|
|
/// </remarks>
|
|
[EditorBrowsable(EditorBrowsableState.Never)]
|
|
public interface IConcurrencyAbstractionLayer
|
|
{
|
|
/// <summary>
|
|
/// Queues a method for execution at the specified relative time.
|
|
/// </summary>
|
|
/// <param name="action">Method to execute.</param>
|
|
/// <param name="state">State to pass to the method.</param>
|
|
/// <param name="dueTime">Time to execute the method on.</param>
|
|
/// <returns>Disposable object that can be used to stop the timer.</returns>
|
|
IDisposable StartTimer(Action<object?> action, object? state, TimeSpan dueTime);
|
|
|
|
/// <summary>
|
|
/// Queues a method for periodic execution based on the specified period.
|
|
/// </summary>
|
|
/// <param name="action">Method to execute; should be safe for reentrancy.</param>
|
|
/// <param name="period">Period for running the method periodically.</param>
|
|
/// <returns>Disposable object that can be used to stop the timer.</returns>
|
|
IDisposable StartPeriodicTimer(Action action, TimeSpan period);
|
|
|
|
/// <summary>
|
|
/// Queues a method for execution.
|
|
/// </summary>
|
|
/// <param name="action">Method to execute.</param>
|
|
/// <param name="state">State to pass to the method.</param>
|
|
/// <returns>Disposable object that can be used to cancel the queued method.</returns>
|
|
IDisposable QueueUserWorkItem(Action<object?> action, object? state);
|
|
|
|
/// <summary>
|
|
/// Blocking sleep operation.
|
|
/// </summary>
|
|
/// <param name="timeout">Time to sleep.</param>
|
|
void Sleep(TimeSpan timeout);
|
|
|
|
/// <summary>
|
|
/// Starts a new stopwatch object.
|
|
/// </summary>
|
|
/// <returns>New stopwatch object; started at the time of the request.</returns>
|
|
IStopwatch StartStopwatch();
|
|
|
|
/// <summary>
|
|
/// Gets whether long-running scheduling is supported.
|
|
/// </summary>
|
|
bool SupportsLongRunning { get; }
|
|
|
|
/// <summary>
|
|
/// Starts a new long-running thread.
|
|
/// </summary>
|
|
/// <param name="action">Method to execute.</param>
|
|
/// <param name="state">State to pass to the method.</param>
|
|
void StartThread(Action<object?> action, object? state);
|
|
}
|
|
}
|