DotNext.Threading by .NET Foundation and Contributors

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

---

API Diff between 5.18.1 and 4.0.0-beta.1

220 Additions 21 Removals

DotNext.Collections.Concurrent

• public struct IndexPool : ISupplier<int>, IFunctional<Func<int>>, IConsumer<int>, IFunctional<Action<int>>, IReadOnlyCollection<int>, IEnumerable<int>, IEnumerable, IResettable
  • public struct Enumerator : IEnumerator<Enumerator, int>
  • public static int Capacity { get; }
  • public static int MaxValue { get; }
  • public int Count { get; }
  • public bool IsEmpty { get; set; }
  • public IndexPool()
  • public IndexPool(int maxValue)
  • public bool Contains(int value)
  • public Enumerator GetEnumerator()
  • public void Reset()
  • public void Return(int value)
  • public void Return(ReadOnlySpan<int> indices)
  • public int Take()
  • public int Take(Span<int> indices)
  • public bool TryPeek(out int result)
  • public bool TryTake(out int result)

DotNext.Runtime.Caching

• public class RandomAccessCache<TKey, TValue> : Disposable, IAsyncDisposable
  • public struct ReadOrWriteSession<TKey, TValue> : IDisposable
  • public struct ReadSession<TKey, TValue> : IDisposable
  • public Action<TKey, TValue> Eviction { get; set; }
  • public IEqualityComparer<TKey> KeyComparer { get; set; }
  • public RandomAccessCache(int cacheSize)
  • public ReadOrWriteSession<TKey, TValue> Change(TKey key, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<ReadOrWriteSession<TKey, TValue>> ChangeAsync(TKey key, CancellationToken token = default)
  • public ValueTask DisposeAsync()
  • public bool Invalidate(TKey key, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<bool> InvalidateAsync(TKey key, CancellationToken token = default)
  • public ValueTask InvalidateAsync(CancellationToken token = default)
  • public bool TryRead(TKey key, out ReadSession session)
  • public bool TryRemove(TKey key, out ReadSession session, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<ReadSession<TKey, TValue>?> TryRemoveAsync(TKey key, CancellationToken token = default)

DotNext.Threading

• public static class AsyncBridge
  • public static CancellationToken AsCancellationToken(this Task task)
  • public static CancellationToken AsCancellationToken(this Task task, out Func disposeTokenSource)
  • public static Task<CancellationToken> WaitAnyAsync(this ReadOnlySpan<CancellationToken> tokens)
  • public static Task<CancellationToken> WaitAnyAsync(this ReadOnlySpan<CancellationToken> tokens, out Func interruption)
  • public static ValueTask<bool> WaitAsync(this WaitHandle handle, TimeSpan timeout)
  • public static ValueTask<bool> WaitAsync(this WaitHandle handle)
  • public static ValueTask<bool> WaitAsync(this WaitHandle handle, TimeSpan timeout, CancellationToken token = default)
  • public static ValueTask WaitAsync(this WaitHandle handle, CancellationToken token = default)
• public class AsyncCorrelationSource<TKey, TValue>
  • public bool Pulse(TKey eventId, TValue value)
  • public bool Pulse(TKey eventId, ref Result value)
  • public bool Pulse(TKey eventId, ref Result value, out object userData)
  • public ValueTask<TValue> WaitAsync(TKey eventId, object userData, TimeSpan timeout, CancellationToken token = default)
• public class AsyncCounter : QueuedSynchronizer, IAsyncEvent, IDisposable, IResettable
  • public void Increment(long delta)
• public class AsyncEventHub : QueuedSynchronizer, IResettable
  • public struct EventGroup : IReadOnlyCollection<int>, IEnumerable<int>, IEnumerable, IEquatable<EventGroup>
  • public int Count { get; }
  • public AsyncEventHub(int count)
  • public EventGroup CaptureState()
  • public bool Pulse(int eventIndex)
  • public EventGroup Pulse(ref EventGroup events)
  • public EventGroup PulseAll()
  • public void Reset()
  • public bool ResetAndPulse(int eventIndex)
  • public EventGroup ResetAndPulse(ref EventGroup events)
  • public ValueTask WaitAllAsync(ref EventGroup events, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAllAsync(ref EventGroup events, CancellationToken token = default)
  • public ValueTask WaitAllAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAllAsync(CancellationToken token = default)
  • public ValueTask WaitAnyAsync(ref EventGroup events, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAnyAsync(ref EventGroup events, CancellationToken token = default)
  • public ValueTask WaitAnyAsync(ref EventGroup events, ICollection<int> output, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAnyAsync(ref EventGroup events, ICollection<int> output, CancellationToken token = default)
  • public ValueTask WaitAnyAsync(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAnyAsync(CancellationToken token = default)
  • public ValueTask WaitAnyAsync(ICollection<int> output, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAnyAsync(ICollection<int> output, CancellationToken token = default)
  • public ValueTask WaitOneAsync(int eventIndex, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitOneAsync(int eventIndex, CancellationToken token = default)
• public class AsyncExclusiveLock : QueuedSynchronizer, IAsyncDisposable
  • public ValueTask StealAsync(object reason, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask StealAsync(object reason = null, CancellationToken token = default)
  • public bool TryAcquire(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(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 ValueTask<Holder> TryAcquireAsync(CancellationToken token)
• public static class AsyncLockAcquisition
  • public static ValueTask<Holder> AcquireLockAsync<T>(this T obj, TimeSpan timeout, CancellationToken token = default)
  • public static ValueTask<Holder> AcquireReadLockAsync<T>(this T obj, TimeSpan timeout, CancellationToken token = default)
  • public static ValueTask<Holder> SuppressCancellation(this ValueTask<Holder> result)
  • public static ValueTask<Holder> SuppressDisposedState(this ValueTask<Holder> result)
  • public static ValueTask<Holder> SuppressDisposedStateOrCancellation(this ValueTask<Holder> result)
  • public static ValueTask<Holder> AcquireWriteLockAsync<T>(this T obj, TimeSpan timeout, CancellationToken token = default)
  • public static ValueTask<Holder> AcquireWriteLockAsync<T>(this T obj, bool upgrade, CancellationToken token = default)
  • public static ValueTask<Holder> AcquireWriteLockAsync<T>(this T obj, bool upgrade, TimeSpan timeout, CancellationToken token = default)
• public class AsyncManualResetEvent : QueuedSynchronizer, IAsyncResetEvent, IAsyncEvent, IDisposable, IResettable
  • public ValueTask<bool> WaitAsync<T>(Predicate<T> condition, T arg, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAsync<T>(Predicate<T> condition, T arg, CancellationToken token = default)
  • public ValueTask<bool> WaitAsync<T1, T2>(Func<T1, T2, bool> condition, T1 arg1, T2 arg2, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask WaitAsync<T1, T2>(Func<T1, T2, bool> condition, T1 arg1, T2 arg2, CancellationToken token = default)
• public class AsyncReaderWriterLock : QueuedSynchronizer, IAsyncDisposable
  • public ValueTask StealWriteLockAsync(object reason, TimeSpan timeout, CancellationToken token = default)
  • public ValueTask StealWriteLockAsync(object reason = null, CancellationToken token = default)
  • public bool TryEnterReadLock(TimeSpan timeout, CancellationToken token = default)
  • public bool TryEnterWriteLock(TimeSpan timeout, CancellationToken token = default)
  • public ValueTask<bool> TryStealWriteLockAsync(object reason, TimeSpan timeout, CancellationToken token = default)
• public class AsyncTrigger : QueuedSynchronizer, IAsyncEvent, IDisposable, IResettable
  • 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 Task WaitAsync<TStateMachine>(TStateMachine stateMachine, Predicate<TStateMachine> condition, CancellationToken token = default)
• public class AsyncTrigger<TState> : QueuedSynchronizer
• public interface IAsyncEvent : IDisposable, IResettable
  • bool Wait(TimeSpan timeout)
• public abstract class LinkedCancellationTokenSource : CancellationTokenSource
  • public CancellationToken CancellationOrigin { get; }
• public static class LinkedTokenSourceFactory
  • public static CancellationTokenSource LinkTo(this ref CancellationToken first, CancellationToken second)
  • public static bool CausedBy(this OperationCanceledException e, LinkedCancellationTokenSource source, CancellationToken token)
  • public static LinkedCancellationTokenSource LinkTo(this ref CancellationToken first, CancellationToken second)
  • public static LinkedCancellationTokenSource LinkTo(this ref CancellationToken first, ReadOnlySpan<CancellationToken> tokens)
• public class PendingTaskInterruptedException : Exception
  • public object Reason { get; set; }
  • public PendingTaskInterruptedException(string message = null, Exception innerException = null)
• public class QueuedSynchronizer : Disposable
  • public void Dispose(Exception reason)
  • public IReadOnlyList<object> GetSuspendedCallers()
  • public void SetCallerInformation(object information)
  • public void TrackSuspendedCallers(Func<object> callerInfoProvider = null)
• 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 sealed class PersistentChannelOptions : ChannelOptions
  • public TagList MeasurementTags { get; set; }
  • public IncrementingEventCounter ReadRateCounter { get; set; }
  • public IncrementingEventCounter WriteRateCounter { get; set; }
  • public bool ReliableEnumeration { get; set; }

DotNext.Threading.Leases

• public abstract class LeaseConsumer : Disposable, IAsyncDisposable
  • protected struct AcquisitionResult
  • public double ClockDriftBound { get; set; }
  • public Timeout& modreq(System.Runtime.InteropServices.InAttribute) Expiration { get; }
  • public LeaseIdentity& modreq(System.Runtime.InteropServices.InAttribute) LeaseId { get; }
  • public CancellationToken Token { get; }
  • protected LeaseConsumer(TimeProvider provider = null)
  • public ValueTask AcquireAsync(TimeSpan pauseDuration, Random pauseRandomizer = null, CancellationToken token = default)
  • public ValueTask DisposeAsync()
  • public Task<TResult> ExecuteAsync<TResult>(Func<CancellationToken, Task<TResult>> worker, CancellationToken token = default)
  • public ValueTask<bool> ReleaseAsync(CancellationToken token = default)
  • protected abstract ValueTask<LeaseIdentity?> ReleaseCoreAsync(LeaseIdentity identity, CancellationToken token)
  • public ValueTask<bool> TryAcquireAsync(CancellationToken token = default)
  • protected abstract ValueTask<AcquisitionResult?> TryAcquireCoreAsync(CancellationToken token = default)
  • public ValueTask<bool> TryRenewAsync(CancellationToken token = default)
  • protected abstract ValueTask<AcquisitionResult?> TryRenewCoreAsync(LeaseIdentity identity, CancellationToken token)
• public struct LeaseIdentity : IEquatable<LeaseIdentity>
  • public const ulong InitialVersion = 0
  • public Guid Id { get; set; }
  • public ulong Version { get; set; }
  • public static bool op_Equality(ref LeaseIdentity x, ref LeaseIdentity y)
  • public static bool op_Inequality(ref LeaseIdentity x, ref LeaseIdentity y)
  • public static bool op_LeftShift(ref LeaseIdentity x, ref LeaseIdentity y)
  • public static bool op_RightShift(ref LeaseIdentity x, ref LeaseIdentity y)
  • public bool Equals(LeaseIdentity other)
  • public bool Precedes(ref LeaseIdentity other)
• public abstract class LeaseProvider<TMetadata> : Disposable
  • public struct AcquisitionResult<TMetadata>
  • public struct State<TMetadata>
  • protected CancellationToken LifetimeToken { get; }
  • public TimeSpan TimeToLive { get; }
  • protected LeaseProvider(TimeSpan ttl, TimeProvider provider = null)
  • public ValueTask<AcquisitionResult<TMetadata>> AcquireAsync<TArg>(TArg arg, Func<TArg, TMetadata, CancellationToken, ValueTask<TMetadata>> updater, CancellationToken token = default)
  • public ValueTask<AcquisitionResult<TMetadata>> AcquireAsync(CancellationToken token = default)
  • protected abstract ValueTask<State<TMetadata>> GetStateAsync(CancellationToken token)
  • public ValueTask<LeaseIdentity?> ReleaseAsync<TArg>(LeaseIdentity identity, TArg arg, Func<TArg, TMetadata, CancellationToken, ValueTask<TMetadata>> updater, CancellationToken token = default)
  • public ValueTask<LeaseIdentity?> ReleaseAsync(LeaseIdentity identity, CancellationToken token = default)
  • public ValueTask<AcquisitionResult<TMetadata>?> TryAcquireAsync<TArg>(TArg arg, Func<TArg, TMetadata, CancellationToken, ValueTask<TMetadata>> updater, CancellationToken token = default)
  • public ValueTask<AcquisitionResult<TMetadata>?> TryAcquireAsync(CancellationToken token = default)
  • public ValueTask<AcquisitionResult<TMetadata>?> TryAcquireOrRenewAsync<TArg>(LeaseIdentity identity, TArg arg, Func<TArg, TMetadata, CancellationToken, ValueTask<TMetadata>> updater, CancellationToken token = default)
  • public ValueTask<AcquisitionResult<TMetadata>?> TryAcquireOrRenewAsync(LeaseIdentity identity, CancellationToken token = default)
  • public ValueTask<AcquisitionResult<TMetadata>?> TryRenewAsync<TArg>(LeaseIdentity identity, bool reacquire, TArg arg, Func<TArg, TMetadata, CancellationToken, ValueTask<TMetadata>> updater, CancellationToken token = default)
  • public ValueTask<AcquisitionResult<TMetadata>?> TryRenewAsync(LeaseIdentity identity, bool reacquire, CancellationToken token = default)
  • protected abstract ValueTask<bool> TryUpdateStateAsync(State<TMetadata> state, CancellationToken token)
  • public ValueTask<LeaseIdentity> UnsafeReleaseAsync<TArg>(TArg arg, Func<TArg, TMetadata, CancellationToken, ValueTask<TMetadata>> updater, CancellationToken token = default)
  • public ValueTask<LeaseIdentity> UnsafeReleaseAsync(CancellationToken token = default)
  • public ValueTask<LeaseIdentity?> UnsafeTryReleaseAsync<TArg>(TArg arg, Func<TArg, TMetadata, CancellationToken, ValueTask<TMetadata>> updater, CancellationToken token = default)
  • public ValueTask<LeaseIdentity?> UnsafeTryReleaseAsync(CancellationToken token = default)

DotNext.Threading.Tasks

• public abstract class ManualResetCompletionSource
  • protected const short InitialCompletionToken = -32768
  • protected object CompletionData { get; }
  • public ManualResetCompletionSourceStatus Status { get; }
  • protected virtual void CleanUp()
  • public void OnCompleted(Action<object> continuation, object state, short token, ValueTaskSourceOnCompletedFlags flags)
  • public bool TryReset(out short token)
  • public abstract bool TrySetCanceled(object completionData, CancellationToken token)
  • 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> Consume<T>(this TaskCompletionPipe<Task<T>> pipe)
  • public static Consumer<T> Consume<T>(this ReadOnlySpan<Task<T>> tasks)
  • public static IAsyncEnumerable<T> WhenEach<T>(ReadOnlySpan<T> tasks) where T : Task
• public class TaskCompletionPipe<T> : IAsyncEnumerable<T>, IResettable where T : Task
  • public Task Completion { get; }
  • public bool IsCompletionTaskSupported { get; set; }
  • public TaskCompletionPipe()
  • public void Add(T task)
  • public void Add(T task, object userData)
  • public void Add(ReadOnlySpan<T> tasks, bool complete = false, object userData = null)
  • 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 TaskQueue<T> : IAsyncEnumerable<T>, IResettable where T : Task
  • public bool CanEnqueue { get; }
  • public T HeadTask { get; }
  • public TaskQueue(int capacity)
  • public void Clear()
  • public ValueTask<T> DequeueAsync(CancellationToken token = default)
  • public ValueTask EnqueueAsync(T task, CancellationToken token = default)
  • public ValueTask EnsureFreeSpaceAsync(CancellationToken token = default)
  • public IAsyncEnumerator<T> GetAsyncEnumerator(CancellationToken token)
  • public bool TryDequeue(out T task)
  • public ValueTask<T> TryDequeueAsync(CancellationToken token = default)
  • public bool TryEnqueue(T task)
• public class ValueTaskCompletionSource : ManualResetCompletionSource, IValueTaskSource, ISupplier<TimeSpan, CancellationToken, ValueTask>, IFunctional<Func<TimeSpan, CancellationToken, ValueTask>>
  • public TaskCompletionSource CreateLinkedTaskCompletionSource(object userData, TimeSpan timeout, CancellationToken token)
  • public bool TrySetCanceled(object completionData, short completionToken, CancellationToken token)
  • public bool TrySetException(object completionData, short completionToken, Exception e)
  • public bool TrySetResult(object completionData)
  • 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 TaskCompletionSource<T> CreateLinkedTaskCompletionSource(object userData, TimeSpan timeout, CancellationToken token)
  • public ValueTaskSourceStatus GetStatus(short token)
  • public bool TrySetCanceled(object completionData, short completionToken, CancellationToken token)
  • public bool TrySetException(object completionData, short completionToken, Exception e)
  • public bool TrySetResult(object completionData, T value)
  • public bool TrySetResult(object completionData, short completionToken, T value)
• public static class ValueTaskSynchronization