DotNext.Threading by .NET Foundation and Contributors

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

---

API Diff between 3.3.1 and 1.1.0

177 Additions 49 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, ISynchronizer, IDisposable
  • public Task<bool> Wait(TimeSpan timeout, CancellationToken token)
  • public Task<bool> WaitAsync(TimeSpan timeout, CancellationToken token)
• public class AsyncBarrier : Disposable, IAsyncEvent, ISynchronizer, IDisposable
  • 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 Task<bool> SignalAndWaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task SignalAndWaitAsync(CancellationToken token)
  • public Task SignalAndWaitAsync()
  • public Task<bool> WaitAsync(TimeSpan timeout, CancellationToken token)
• 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 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(long concurrencyLevel, IEqualityComparer<TKey> comparer = null)
  • public void ClearCache()
  • public bool Pulse(TKey eventId, TValue value)
  • public void PulseAll(TValue value)
  • public void PulseAll(Exception e)
  • public void PulseAll(CancellationToken token)
  • public ValueTask<TValue> WaitAsync(TKey eventId, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<TValue> WaitAsync(TKey eventId, CancellationToken token = default)
• public class AsyncCounter : QueuedSynchronizer, IAsyncEvent, ISynchronizer, IDisposable
  • public long Value { get; }
  • public AsyncCounter(long initialValue = 0)
  • public void Increment()
  • public bool TryDecrement()
  • public Task<bool> WaitAsync(TimeSpan timeout, CancellationToken token)
• public static class AsyncEvent
  • public static Task<bool> Wait(this IAsyncEvent event, TimeSpan timeout)
  • public static Task Wait(this IAsyncEvent event, CancellationToken token)
  • public static Task Wait(this IAsyncEvent event)
  • public static Task<bool> WaitAsync(this IAsyncEvent event, TimeSpan timeout)
  • public static Task WaitAsync(this IAsyncEvent event, CancellationToken token)
  • public static Task WaitAsync(this IAsyncEvent event)
• 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 Task Acquire(TimeSpan timeout)
  • public Task Acquire(CancellationToken token)
  • public Task AcquireAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task AcquireAsync(CancellationToken token)
  • public ValueTask DisposeAsync()
  • public Task<bool> TryAcquire(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryAcquire(TimeSpan timeout)
  • public bool TryAcquire()
  • public Task<bool> TryAcquireAsync(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryAcquireAsync(TimeSpan timeout)
• public class AsyncLazy<T>
  • public AsyncLazy(ValueFunc<Task<T>> valueFactory, bool resettable = false)
• public struct AsyncLock : IDisposable, IEquatable<AsyncLock>, IAsyncDisposable
  • public Task<Holder> Acquire(CancellationToken token)
  • public Task<Holder> Acquire(TimeSpan timeout)
  • public Task<Holder> AcquireAsync(CancellationToken token)
  • public Task<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 Task<Holder> TryAcquireAsync(TimeSpan timeout, bool suppressCancellation, CancellationToken token)
  • public Task<Holder> TryAcquireAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task<Holder> TryAcquireAsync(CancellationToken token)
• public static class AsyncLockAcquisition
  • public static Task<Holder> SuppressCancellation(this Task<Holder> result)
  • public static Task<Holder> SuppressDisposedState(this Task<Holder> result)
  • public static Task<Holder> SuppressDisposedStateOrCancellation(this Task<Holder> result)
• public class AsyncReaderWriterLock : QueuedSynchronizer, IAsyncDisposable
  • public struct LockStamp : IEquatable<LockStamp>
  • 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 ValueTask DisposeAsync()
  • public Task EnterReadLockAsync(CancellationToken token)
  • public Task EnterReadLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task EnterUpgradeableReadLockAsync(CancellationToken token)
  • public Task EnterUpgradeableReadLockAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task EnterWriteLockAsync(CancellationToken token)
  • public Task EnterWriteLockAsync(TimeSpan timeout, 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 Task<bool> TryEnterUpgradeableReadLock(TimeSpan timeout)
  • public Task<bool> TryEnterWriteLock(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryEnterWriteLock(TimeSpan timeout)
  • public bool TryEnterReadLock()
  • public Task<bool> TryEnterReadLockAsync(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryEnterReadLockAsync(TimeSpan timeout)
  • public bool TryEnterUpgradeableReadLock()
  • public Task<bool> TryEnterUpgradeableReadLockAsync(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryEnterUpgradeableReadLockAsync(TimeSpan timeout)
  • public bool TryEnterWriteLock(ref LockStamp stamp)
  • public bool TryEnterWriteLock()
  • public Task<bool> TryEnterWriteLockAsync(TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryEnterWriteLockAsync(TimeSpan timeout)
  • public LockStamp TryOptimisticRead()
  • public bool Validate(ref LockStamp stamp)
• public class AsyncSharedLock : QueuedSynchronizer, IAsyncDisposable
  • public bool IsStrongLockHeld { get; }
  • public Task Acquire(bool strongLock, TimeSpan timeout)
  • public Task Acquire(bool strongLock, CancellationToken token)
  • public Task AcquireAsync(bool strongLock, TimeSpan timeout, CancellationToken token = default)
  • public Task AcquireAsync(bool strongLock, CancellationToken token)
  • public ValueTask DisposeAsync()
  • public void Downgrade()
  • public Task<bool> TryAcquire(bool strongLock, TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryAcquire(bool strongLock, TimeSpan timeout)
  • public bool TryAcquire(bool strongLock)
  • public Task<bool> TryAcquireAsync(bool strongLock, TimeSpan timeout, CancellationToken token)
  • public Task<bool> TryAcquireAsync(bool strongLock, TimeSpan timeout)
• public class AsyncTimer : Disposable, IAsyncDisposable
  • public AsyncTimer(ValueFunc<CancellationToken, Task<bool>> callback)
  • public ValueTask DisposeAsync()
• public class ConcurrentObjectPool<T> : Disposable
• public class AsyncTrigger : QueuedSynchronizer, IAsyncEvent, ISynchronizer, IDisposable
  • public AsyncTrigger()
  • public bool EnsureState<TState>(TState state, Predicate<TState> condition)
  • public void Signal()
  • public void Signal<TState>(TState state)
  • public void Signal<TState>(TState state, bool fairness)
  • public void Signal<TState, TArgs>(TState state, Action<TState, TArgs> mutator, TArgs args)
  • public void Signal<TState, TArgs>(TState state, Action<TState, TArgs> mutator, TArgs args, bool fairness)
  • public void Signal<TState>(TState state, Action<TState> mutator)
  • public void Signal<TState>(TState state, Action<TState> mutator, bool fairness)
  • public Task<bool> SignalAndWaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task SignalAndWaitAsync(CancellationToken token = default)
  • public Task<bool> SignalAndWaitAsync<TState>(TState state, Predicate<TState> condition, TimeSpan timeout, CancellationToken token = default)
  • public Task<bool> SignalAndWaitAsync<TState>(TState state, Predicate<TState> condition, TimeSpan timeout, bool fairness, CancellationToken token = default)
  • public Task SignalAndWaitAsync<TState>(TState state, Predicate<TState> condition, CancellationToken token = default)
  • public Task SignalAndWaitAsync<TState>(TState state, Predicate<TState> condition, bool fairness, CancellationToken token = default)
  • public Task<bool> SignalAndWaitAsync<TState, TArgs>(TState state, Action<TState, TArgs> mutator, TArgs args, Predicate<TState> condition, TimeSpan timeout, CancellationToken token = default)
  • public Task<bool> SignalAndWaitAsync<TState, TArgs>(TState state, Action<TState, TArgs> mutator, TArgs args, Predicate<TState> condition, TimeSpan timeout, bool fairness, CancellationToken token = default)
  • public Task SignalAndWaitAsync<TState, TArgs>(TState state, Action<TState, TArgs> mutator, TArgs args, Predicate<TState> condition, CancellationToken token = default)
  • public Task SignalAndWaitAsync<TState, TArgs>(TState state, Action<TState, TArgs> mutator, TArgs args, Predicate<TState> condition, bool fairness, CancellationToken token = default)
  • public Task<bool> SignalAndWaitAsync<TState>(TState state, Action<TState> mutator, Predicate<TState> condition, TimeSpan timeout, CancellationToken token = default)
  • public Task<bool> SignalAndWaitAsync<TState>(TState state, Action<TState> mutator, Predicate<TState> condition, TimeSpan timeout, bool fairness, CancellationToken token = default)
  • public Task SignalAndWaitAsync<TState>(TState state, Action<TState> mutator, Predicate<TState> condition, CancellationToken token = default)
  • public Task SignalAndWaitAsync<TState>(TState state, Action<TState> mutator, Predicate<TState> condition, bool fairness, CancellationToken token = default)
  • public Task<bool> WaitAsync(TimeSpan timeout, CancellationToken token = default)
  • public Task<bool> WaitAsync<TState>(TState state, Predicate<TState> condition, TimeSpan timeout, CancellationToken token = default)
  • public Task WaitAsync<TState>(TState state, Predicate<TState> condition, CancellationToken token = default)
• public sealed class ExchangeTerminatedException : Exception
• public interface IAsyncEvent : ISynchronizer, IDisposable
  • Task<bool> Wait(TimeSpan timeout, CancellationToken token)
  • Task<bool> WaitAsync(TimeSpan timeout, CancellationToken token)
• public interface ISynchronizer
  • bool HasWaiters { get; }
  • bool HasAnticipants { get; }
• public static class LinkedTokenSourceFactory
  • public static CancellationTokenSource LinkTo(this ref CancellationToken first, CancellationToken second)
• public abstract class QueuedSynchronizer : Disposable, ISynchronizer
  • public void CancelSuspendedCallers(CancellationToken token)
• public abstract class Synchronizer : Disposable, ISynchronizer
  • public Task<bool> Wait(TimeSpan timeout, CancellationToken token)
  • public Task<bool> WaitAsync(TimeSpan timeout, CancellationToken token)
  • public Task<bool> WaitAsync<T>(Predicate<T> condition, T arg, TimeSpan timeout, CancellationToken token = default)
  • public Task WaitAsync<T>(Predicate<T> condition, T arg, CancellationToken token = default)
  • public Task<bool> WaitAsync<T1, T2>(Func<T1, T2, bool> condition, T1 arg1, T2 arg2, TimeSpan timeout, CancellationToken token = default)
  • public Task WaitAsync<T1, T2>(Func<T1, T2, bool> condition, T1 arg1, T2 arg2, 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 double Throughput { get; }
  • protected PersistentChannel(PersistentChannelOptions options)
  • protected abstract ValueTask<TOutput> DeserializeAsync(Stream input, CancellationToken token)
  • protected virtual void Dispose(bool disposing)
  • public void Dispose()
  • protected abstract ValueTask SerializeAsync(TInput input, Stream output, CancellationToken token)
• public sealed class PersistentChannelOptions : ChannelOptions
  • public int BufferSize { get; set; }
  • public long InitialPartitionSize { get; set; }
  • public string Location { get; set; }
  • public int PartitionCapacity { get; set; }
  • public IncrementingEventCounter ReadRateCounter { get; set; }
  • public IncrementingEventCounter WriteRateCounter { get; set; }
  • public PersistentChannelOptions()

DotNext.Threading.Tasks

• public abstract class Future : IFuture, INotifyCompletion, IValueTaskSource
  • public interface IAwaiter
  • public bool IsCompleted { get; }
  • protected Future(bool runContinuationsAsynchronously = true, bool continueOnCapturedContext = false)
  • public ValueTask AsTask()
  • protected void Complete(Exception e = null)
  • protected void GetResult()
  • public void OnCompleted(Action callback)
• public abstract class Future<TResult> : IFuture, INotifyCompletion, IValueTaskSource<TResult>
  • public interface IAwaiter<TResult>
  • public bool IsCompleted { get; }
  • protected Future(bool runContinuationsAsynchronously = true, bool continueOnCapturedContext = false)
  • public ValueTask<TResult> AsTask()
  • protected void Complete(Result<TResult> e)
  • protected TResult GetResult()
  • public void OnCompleted(Action callback)
• public abstract class ManualResetCompletionSource : IThreadPoolWorkItem
  • protected virtual void AfterConsumed()
  • public short Reset()
  • public abstract bool TrySetCanceled(CancellationToken token)
  • public abstract bool TrySetException(Exception e)
• public abstract class ManualResetCompletionSource<T> : ManualResetCompletionSource where T : struct, IEquatable<T>
  • public T CreateTask(TimeSpan timeout, CancellationToken token)
• public class ValueTaskCompletionSource : ManualResetCompletionSource<ValueTask>, IValueTaskSource
  • public ValueTaskCompletionSource(bool runContinuationsAsynchronously = true)
  • protected virtual void BeforeCompleted(Exception e)
  • protected virtual Exception OnCanceled(CancellationToken token)
  • protected virtual Exception OnTimeout()
  • public bool TrySetCanceled(short completionToken, CancellationToken token)
  • public bool TrySetException(short completionToken, Exception e)
  • public bool TrySetResult()
  • public bool TrySetResult(short completionToken)
• public class ValueTaskCompletionSource<T> : ManualResetCompletionSource<ValueTask<T>>, IValueTaskSource<T>
  • public ValueTaskCompletionSource(bool runContinuationsAsynchronously = true)
  • protected virtual void BeforeCompleted(Result<T> result)
  • protected virtual Result<T> OnCanceled(CancellationToken token)
  • protected virtual Result<T> OnTimeout()
  • public bool TrySetCanceled(short completionToken, CancellationToken token)
  • public bool TrySetException(short completionToken, Exception e)
  • public bool TrySetResult(T value)
  • public bool TrySetResult(short completionToken, T value)
• public static class ValueTaskSynchronization
  • public static ValueTask<ValueTask<R>> WhenAny<R>(ValueTask<R> task1, ValueTask<R> task2)
  • public static ValueTask<ValueTask<TResult>> WhenAny<TResult>(ValueTask<TResult> task1, ValueTask<TResult> task2)
  • public static ValueTask<ValueTask<R>> WhenAny<R>(ValueTask<R> task1, ValueTask<R> task2, ValueTask<R> task3)
  • public static ValueTask<ValueTask<TResult>> WhenAny<TResult>(ValueTask<TResult> task1, ValueTask<TResult> task2, ValueTask<TResult> task3)
  • public static ValueTask<ValueTask<R>> WhenAny<R>(ValueTask<R> task1, ValueTask<R> task2, ValueTask<R> task3, ValueTask<R> task4)
  • public static ValueTask<ValueTask<TResult>> WhenAny<TResult>(ValueTask<TResult> task1, ValueTask<TResult> task2, ValueTask<TResult> task3, ValueTask<TResult> task4)
  • public static ValueTask<ValueTask<R>> WhenAny<R>(ValueTask<R> task1, ValueTask<R> task2, ValueTask<R> task3, ValueTask<R> task4, ValueTask<R> task5)
  • public static ValueTask<ValueTask<TResult>> WhenAny<TResult>(ValueTask<TResult> task1, ValueTask<TResult> task2, ValueTask<TResult> task3, ValueTask<TResult> task4, ValueTask<TResult> task5)