DotNext.Threading by .NET Foundation and Contributors

<PackageReference Include="DotNext.Threading" Version="5.0.1" />

---

API Diff between 5.0.1 and 1.3.1

218 Additions 67 Removals

DotNext.Runtime.CompilerServices

• public sealed class CancellationTokenFuture : Future<Task>, IAwaiter, IFuture, INotifyCompletion
• public sealed class WaitHandleFuture : Future<Task<bool>>, IAwaiter<bool>, IFuture, INotifyCompletion

DotNext.Threading

• public class AsyncAutoResetEvent : QueuedSynchronizer, IAsyncResetEvent, IAsyncEvent, IDisposable, IResettable
  • public AsyncAutoResetEvent(bool initialState, int concurrencyLevel)
  • public Task<bool> Wait(TimeSpan timeout, CancellationToken token)
  • public ValueTask<bool> WaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAsync(CancellationToken token = default)
• public class AsyncBarrier : Disposable, IAsyncEvent, IDisposable, IResettable
  • protected virtual Task PostPhase(long phase)
  • protected virtual ValueTask PostPhase(long phase)
  • public Task<bool> SignalAndWait(TimeSpan timeout, CancellationToken token)
  • public Task SignalAndWait(CancellationToken token)
  • public Task<bool> SignalAndWait(TimeSpan timeout)
  • public Task SignalAndWait()
  • public Task<bool> Wait(TimeSpan timeout, CancellationToken token)
  • public ValueTask<bool> SignalAndWaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask SignalAndWaitAsync(CancellationToken token = default)
  • public ValueTask<bool> WaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAsync(CancellationToken token = default)
• public static class AsyncBridge
  • public static CancellationTokenFuture WaitAsync(this CancellationToken token, bool completeAsCanceled = false)
  • public static WaitHandleFuture WaitAsync(this WaitHandle handle, TimeSpan timeout)
  • public static WaitHandleFuture WaitAsync(this WaitHandle handle)
  • public static int MaxPoolSize { get; set; }
  • public static ValueTask WaitAsync(this CancellationToken token, bool completeAsCanceled = false)
  • public static ValueTask<bool> WaitAsync(this WaitHandle handle, TimeSpan timeout)
  • public static ValueTask<bool> WaitAsync(this WaitHandle handle)
• public class AsyncCorrelationSource<TKey, TValue>
  • public AsyncCorrelationSource(int concurrencyLevel, IEqualityComparer<TKey> comparer = null)
  • public bool Pulse(TKey eventId, ref Result value)
  • public bool Pulse(TKey eventId, ref Result value, out object userData)
  • public void PulseAll(TValue value)
  • public void PulseAll(Exception e)
  • public void PulseAll(CancellationToken token)
  • public ValueTask<TValue> WaitAsync(TKey eventId, object userData, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<TValue> WaitAsync(TKey eventId, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<TValue> WaitAsync(TKey eventId, CancellationToken token = default)
• public class AsyncCountdownEvent : QueuedSynchronizer, IAsyncEvent, IDisposable, IResettable
  • public bool IsSet { get; }
  • public AsyncCountdownEvent(long initialCount, int concurrencyLevel)
  • public bool Signal()
  • public ValueTask<bool> WaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAsync(CancellationToken token = default)
• public class AsyncCounter : QueuedSynchronizer, IAsyncEvent, IDisposable, IResettable
  • public AsyncCounter(long initialValue, int concurrencyLevel)
  • public Task<bool> Wait(TimeSpan timeout, CancellationToken token)
  • public void Increment(long delta)
  • public bool TryDecrement()
  • public ValueTask<bool> WaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAsync(CancellationToken token = default)
• public static class AsyncEvent
• public class AsyncEventHub : IResettable
  • public int Count { get; }
  • public AsyncEventHub(int count)
  • public void CancelSuspendedCallers(CancellationToken token)
  • public void CaptureState(Span<bool> states)
  • public bool Pulse(int eventIndex)
  • public int Pulse(ReadOnlySpan<int> eventIndexes)
  • public void Pulse(ReadOnlySpan<int> eventIndexes, Span<bool> flags)
  • public int PulseAll()
  • public void PulseAll(Span<bool> flags)
  • public void Reset()
  • public bool ResetAndPulse(int eventIndex)
  • public int ResetAndPulse(ReadOnlySpan<int> eventIndexes)
  • public void ResetAndPulse(ReadOnlySpan<int> eventIndexes, Span<bool> flags)
  • public Task WaitAllAsync(ReadOnlySpan<int> eventIndexes, TimeSpan timeout, CancellationToken token = default)
  • public Task WaitAllAsync(ReadOnlySpan<int> eventIndexes, CancellationToken token = default)
  • public Task WaitAllAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task WaitAllAsync(CancellationToken token = default)
  • public Task<int> WaitAnyAsync(ReadOnlySpan<int> eventIndexes, TimeSpan timeout, CancellationToken token = default)
  • public Task<int> WaitAnyAsync(ReadOnlySpan<int> eventIndexes, CancellationToken token = default)
  • public Task<int> WaitAnyAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task<int> WaitAnyAsync(CancellationToken token = default)
  • public Task WaitOneAsync(int eventIndex, TimeSpan timeout, CancellationToken token = default)
  • public Task WaitOneAsync(int eventIndex, CancellationToken token = default)
• public class AsyncExchanger<T> : Disposable, IAsyncDisposable
  • public bool IsTerminated { get; }
  • public AsyncExchanger()
  • public ValueTask DisposeAsync()
  • public ValueTask<T> ExchangeAsync(T value, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<T> ExchangeAsync(T value, CancellationToken token = default)
  • public void Terminate(Exception exception = null)
  • public bool TryExchange(ref T value)
• public class AsyncExclusiveLock : QueuedSynchronizer, IAsyncDisposable
  • public AsyncExclusiveLock(int concurrencyLevel)
  • public Task Acquire(TimeSpan timeout)
  • public Task Acquire(CancellationToken token)
  • public ValueTask AcquireAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask AcquireAsync(CancellationToken token = default)
  • public ValueTask StealAsync(object reason, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask StealAsync(object reason = null, CancellationToken token = default)
  • public Task<bool> TryAcquire(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryAcquire(TimeSpan timeout)
  • public ValueTask<bool> TryAcquireAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<bool> TryStealAsync(object reason, TimeSpan timeout, CancellationToken token = default)
• public class AsyncLazy<T> : ISupplier<CancellationToken, Task<T>>, IFunctional<Func<CancellationToken, Task<T>>>, IResettable
  • public Task<T> Task { get; }
  • public AsyncLazy(ValueFunc<Task<T>> valueFactory, bool resettable = false)
  • public AsyncLazy(Func<Task<T>> valueFactory, bool resettable = false)
  • public ConfiguredTaskAwaitable<T> ConfigureAwait(bool continueOnCapturedContext)
  • public TaskAwaiter<T> GetAwaiter()
  • public AsyncLazy(Func<CancellationToken, Task<T>> valueFactory, bool resettable = false)
  • public Task<T> WithCancellation(CancellationToken token)
• public struct AsyncLock : IDisposable, IEquatable<AsyncLock>, IAsyncDisposable
  • public static AsyncLock ReadLock(AsyncReaderWriterLock rwLock, bool upgradeable)
  • public static AsyncLock ReadLock(AsyncReaderWriterLock rwLock)
  • public static AsyncLock WriteLock(AsyncReaderWriterLock rwLock)
  • public Task<Holder> Acquire(CancellationToken token)
  • public Task<Holder> Acquire(TimeSpan timeout)
  • public static AsyncLock WriteLock(AsyncReaderWriterLock rwLock, bool upgrade = false)
  • public ValueTask<Holder> AcquireAsync(CancellationToken token)
  • public ValueTask<Holder> AcquireAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask DisposeAsync()
  • public Task<Holder> TryAcquire(TimeSpan timeout)
  • public Task<Holder> TryAcquire(TimeSpan timeout, CancellationToken token, bool suppressCancellation = false)
  • public Task<Holder> TryAcquire(CancellationToken token)
  • public ValueTask<Holder> TryAcquireAsync(TimeSpan timeout, CancellationToken token = default)
• public static class AsyncLockAcquisition
  • public static Task<Holder> AcquireLockAsync<T>(this T obj, TimeSpan timeout)
  • public static Task<Holder> AcquireLockAsync<T>(this T obj, CancellationToken token)
  • public static Task<Holder> AcquireReadLockAsync<T>(this T obj, TimeSpan timeout)
  • public static Task<Holder> AcquireReadLockAsync<T>(this T obj, CancellationToken token)
  • public static Task<Holder> AcquireUpgradeableReadLockAsync<T>(this T obj, TimeSpan timeout)
  • public static Task<Holder> AcquireUpgradeableReadLockAsync<T>(this T obj, CancellationToken token)
  • public static Task<Holder> AcquireWriteLockAsync<T>(this T obj, TimeSpan timeout)
  • public static Task<Holder> AcquireWriteLockAsync<T>(this T obj, CancellationToken token)
  • public static ValueTask<Holder> AcquireLockAsync<T>(this T obj, TimeSpan timeout)
  • public static ValueTask<Holder> AcquireLockAsync<T>(this T obj, CancellationToken token)
  • public static ValueTask<Holder> AcquireReadLockAsync<T>(this T obj, TimeSpan timeout)
  • public static ValueTask<Holder> AcquireReadLockAsync<T>(this T obj, CancellationToken token)
  • public static ValueTask<Holder> AcquireWriteLockAsync<T>(this T obj, TimeSpan timeout)
  • public static ValueTask<Holder> AcquireWriteLockAsync<T>(this T obj, CancellationToken token)
• public class AsyncManualResetEvent : QueuedSynchronizer, IAsyncResetEvent, IAsyncEvent, IDisposable, IResettable
  • public bool IsSet { get; }
  • public AsyncManualResetEvent(bool initialState, int concurrencyLevel)
  • public ValueTask<bool> WaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAsync(CancellationToken token = default)
• public class AsyncReaderWriterLock : QueuedSynchronizer, IAsyncDisposable
  • public bool IsUpgradeableReadLockHeld { get; }
  • public AsyncReaderWriterLock(int concurrencyLevel)
  • public Task EnterReadLock(CancellationToken token)
  • public Task EnterReadLock(TimeSpan timeout)
  • public Task EnterUpgradeableReadLock(CancellationToken token)
  • public Task EnterUpgradeableReadLock(TimeSpan timeout)
  • public Task EnterWriteLock(CancellationToken token)
  • public Task EnterWriteLock(TimeSpan timeout)
  • public void ExitReadLock()
  • public void ExitUpgradeableReadLock()
  • public void ExitWriteLock()
  • public void DowngradeFromWriteLock()
  • public ValueTask EnterReadLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask EnterReadLockAsync(CancellationToken token = default)
  • public ValueTask EnterWriteLockAsync(CancellationToken token = default)
  • public ValueTask EnterWriteLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public void Release()
  • public ValueTask StealWriteLockAsync(object reason, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask StealWriteLockAsync(object reason = null, CancellationToken token = default)
  • public Task<bool> TryEnterReadLock(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryEnterReadLock(TimeSpan timeout)
  • public Task<bool> TryEnterUpgradeableReadLock(TimeSpan timeout, CancellationToken token)
  • public bool TryEnterUpgradeableReadLock()
  • public Task<bool> TryEnterUpgradeableReadLock(TimeSpan timeout)
  • public ValueTask<bool> TryEnterReadLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task<bool> TryEnterWriteLock(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryEnterWriteLock(TimeSpan timeout)
  • public ValueTask<bool> TryEnterWriteLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<bool> TryStealWriteLockAsync(object reason, TimeSpan timeout, CancellationToken token = default)
  • public bool TryUpgradeToWriteLock()
  • public ValueTask<bool> TryUpgradeToWriteLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask UpgradeToWriteLockAsync(CancellationToken token = default)
  • public ValueTask UpgradeToWriteLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public bool Validate(ref LockStamp stamp)
• public class AsyncSharedLock : QueuedSynchronizer, IAsyncDisposable
  • public bool IsStrongLockHeld { get; }
  • public AsyncSharedLock(long concurrencyLevel)
  • public Task Acquire(bool strongLock, TimeSpan timeout)
  • public Task Acquire(bool strongLock, CancellationToken token)
  • public AsyncSharedLock(long concurrencyLevel, bool limitedConcurrency = true)
  • public ValueTask AcquireAsync(bool strongLock, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask AcquireAsync(bool strongLock, CancellationToken token = default)
  • public Task<bool> TryAcquire(bool strongLock, TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryAcquire(bool strongLock, TimeSpan timeout)
  • public ValueTask<bool> TryAcquireAsync(bool strongLock, TimeSpan timeout, CancellationToken token = default)
• public class AsyncTimer : Disposable
• public class AsyncTrigger : QueuedSynchronizer, IAsyncEvent, IDisposable, IResettable
  • public AsyncTrigger()
  • public AsyncTrigger(int concurrencyLevel)
  • public bool Signal(bool resumeAll = false)
  • public ValueTask<bool> SignalAndWaitAsync(bool resumeAll, bool throwOnEmptyQueue, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask SignalAndWaitAsync(bool resumeAll, bool throwOnEmptyQueue, CancellationToken token = default)
  • public ValueTask<bool> SpinWaitAsync<TCondition>(TCondition condition, TimeSpan timeout, CancellationToken token = default) where TCondition : ISupplier<bool>
  • public ValueTask SpinWaitAsync<TCondition>(TCondition condition, CancellationToken token = default) where TCondition : ISupplier<bool>
  • public ValueTask<bool> WaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAsync(CancellationToken token = default)
• public class ConcurrentObjectPool<T> : Disposable
• public sealed class ExchangeTerminatedException : PendingTaskInterruptedException
• public interface IAsyncEvent : IDisposable, IResettable
  • Task<bool> Wait(TimeSpan timeout, CancellationToken token)
  • ValueTask<bool> WaitAsync(TimeSpan timeout, CancellationToken token = default)
  • ValueTask WaitAsync(CancellationToken token = default)
• public interface ISynchronizer
• public abstract class LinkedCancellationTokenSource : CancellationTokenSource
  • public CancellationToken CancellationOrigin { get; }
• public static class LinkedTokenSourceFactory
  • public static LinkedCancellationTokenSource LinkTo(this ref CancellationToken first, CancellationToken second)
  • public static CancellationTokenSource LinkTo(this ref CancellationToken token, TimeSpan timeout)
  • public static CancellationTokenSource LinkTo(this ref CancellationToken first, TimeSpan timeout, CancellationToken second)
• public class PendingTaskInterruptedException : Exception
  • public object Reason { get; set; }
  • public PendingTaskInterruptedException(string message = null, Exception innerException = null)
• public class QueuedSynchronizer : Disposable
  • public void CancelSuspendedCallers(CancellationToken token)
  • public void Dispose(Exception reason)
  • public ValueTask DisposeAsync()
  • public IReadOnlyList<object> GetSuspendedCallers()
  • public void SetCallerInformation(object information)
  • public void TrackSuspendedCallers(Func<object> callerInfoProvider = null)
• public abstract class Synchronizer : Disposable, ISynchronizer
• public abstract class QueuedSynchronizer<TContext> : QueuedSynchronizer
  • protected QueuedSynchronizer(int? concurrencyLevel)
  • protected ValueTask AcquireAsync(TContext context, TimeSpan timeout, CancellationToken token)
  • protected ValueTask AcquireAsync(TContext context, CancellationToken token)
  • protected virtual void AcquireCore(TContext context)
  • protected abstract bool CanAcquire(TContext context)
  • protected void Release()
  • protected void Release(TContext context)
  • protected virtual void ReleaseCore(TContext context)
  • protected bool TryAcquire(TContext context)
  • protected ValueTask<bool> TryAcquireAsync(TContext context, TimeSpan timeout, CancellationToken token)
• public static class Scheduler
  • public abstract class DelayedTask
  • public abstract class DelayedTask<TResult> : DelayedTask
  • public sealed class DelayedTaskCanceledException : OperationCanceledException
  • public static DelayedTask ScheduleAsync<TArgs>(Func<TArgs, CancellationToken, ValueTask> callback, TArgs args, TimeSpan delay, CancellationToken token = default)
  • public static DelayedTask<TResult> ScheduleAsync<TArgs, TResult>(Func<TArgs, CancellationToken, ValueTask<TResult>> callback, TArgs args, TimeSpan delay, CancellationToken token = default)

DotNext.Threading.Channels

• public abstract class PersistentChannel<TInput, TOutput> : Channel<TInput, TOutput>, IChannelWriter<TInput>, IChannel, IChannelReader<TOutput>, IDisposable
  • public long RemainingCount { get; }
• public sealed class PersistentChannelOptions : ChannelOptions
  • public TagList MeasurementTags { get; set; }
  • public bool ReliableEnumeration { get; set; }

DotNext.Threading.Tasks

• public static class ValueTaskSynchronization
• public abstract class ManualResetCompletionSource
  • protected const short InitialCompletionToken = -32768
  • protected object CompletionData { get; }
  • public bool IsCompleted { get; }
  • public ManualResetCompletionSourceStatus Status { get; }
  • protected virtual void AfterConsumed()
  • protected virtual void Cleanup()
  • public short Reset()
  • public bool TryReset(out short token)
  • public bool TrySetCanceled(CancellationToken token)
  • public abstract bool TrySetCanceled(object completionData, CancellationToken token)
  • public bool TrySetException(Exception e)
  • public abstract bool TrySetException(object completionData, Exception e)
• public enum ManualResetCompletionSourceStatus
  • Activated = 1
  • Consumed = 3
  • WaitForActivation = 0
  • WaitForConsumption = 2
• public static class TaskCompletionPipe
  • public struct Consumer<T> : IAsyncEnumerable<T>
  • public static Consumer<T> GetConsumer<T>(this TaskCompletionPipe<Task<T>> pipe)
• public class TaskCompletionPipe<T> : IAsyncEnumerable<T>, IResettable where T : Task
  • public TaskCompletionPipe()
  • public void Add(T task)
  • public void Add(T task, object userData)
  • public void Complete()
  • public IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken token)
  • public void Reset()
  • public bool TryRead(out T task)
  • public bool TryRead(out T task, out object userData)
  • public ValueTask<bool> WaitToReadAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<bool> WaitToReadAsync(CancellationToken token = default)
• public class ValueTaskCompletionSource : ManualResetCompletionSource, IValueTaskSource, ISupplier<TimeSpan, CancellationToken, ValueTask>, IFunctional<Func<TimeSpan, CancellationToken, ValueTask>>
  • public ValueTaskCompletionSource(bool runContinuationsAsynchronously = true)
  • public TaskCompletionSource CreateLinkedTaskCompletionSource(object userData, TimeSpan timeout, CancellationToken token)
  • public ValueTask CreateTask(TimeSpan timeout, CancellationToken token)
  • protected virtual Exception OnCanceled(CancellationToken token)
  • protected virtual Exception OnTimeout()
  • public bool TrySetCanceled(short completionToken, CancellationToken token)
  • public bool TrySetCanceled(object completionData, short completionToken, CancellationToken token)
  • public bool TrySetException(short completionToken, Exception e)
  • public bool TrySetException(object completionData, short completionToken, Exception e)
  • public bool TrySetResult()
  • public bool TrySetResult(object completionData)
  • public bool TrySetResult(short completionToken)
  • public bool TrySetResult(object completionData, short completionToken)
• public class ValueTaskCompletionSource<T> : ManualResetCompletionSource, IValueTaskSource<T>, IValueTaskSource, ISupplier<TimeSpan, CancellationToken, ValueTask>, IFunctional<Func<TimeSpan, CancellationToken, ValueTask>>, ISupplier<TimeSpan, CancellationToken, ValueTask<T>>, IFunctional<Func<TimeSpan, CancellationToken, ValueTask<T>>>
  • public ValueTaskCompletionSource(bool runContinuationsAsynchronously = true)
  • public TaskCompletionSource<T> CreateLinkedTaskCompletionSource(object userData, TimeSpan timeout, CancellationToken token)
  • public ValueTask<T> CreateTask(TimeSpan timeout, CancellationToken token)
  • protected virtual Result<T> OnCanceled(CancellationToken token)
  • protected virtual Result<T> OnTimeout()
  • public bool TrySetCanceled(short completionToken, CancellationToken token)
  • public bool TrySetCanceled(object completionData, short completionToken, CancellationToken token)
  • public bool TrySetException(short completionToken, Exception e)
  • public bool TrySetException(object completionData, short completionToken, Exception e)
  • public bool TrySetResult(T value)
  • public bool TrySetResult(object completionData, T value)
  • public bool TrySetResult(short completionToken, T value)
  • public bool TrySetResult(object completionData, short completionToken, T value)