ProtoPromise 3.0.0

.NET 5.0 .NET Core 2.1 .NET Standard 2.0 .NET Framework 3.5
There is a newer version of this package available.
See the version list below for details.

Requires NuGet 2.5 or higher.

dotnet add package ProtoPromise --version 3.0.0
NuGet\Install-Package ProtoPromise -Version 3.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="ProtoPromise" Version="3.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add ProtoPromise --version 3.0.0
#r "nuget: ProtoPromise, 3.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
// Install ProtoPromise as a Cake Addin
#addin nuget:?package=ProtoPromise&version=3.0.0

// Install ProtoPromise as a Cake Tool
#tool nuget:?package=ProtoPromise&version=3.0.0

Robust and efficient library for management of asynchronous operations.

  • Allocation-free async operations
  • Cancelable operations with custom allocation-free CancelationToken/Source
  • Allocation-free async iterators with async Linq
  • Progress with enforced normalization
  • async/await support and .Then API
  • Thread safe
  • Full causality traces
  • Easily switch to foreground or background context
  • Combine async operations
  • Circular await detection
  • Interoperable with Tasks
  • CLS compliant

This library was built to work in all C#/.Net ecosystems, including Unity, Mono, .Net Framework, .Net Core, and AOT compilation. It is CLS compliant, so it works with any .Net language.

ProtoPromise conforms to the Promises/A+ Spec as far as is possible with C#.

See full README on GitHub.

Product Compatible and additional computed target framework versions.
.NET net5.0 is compatible.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 is compatible.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net35 is compatible.  net40 is compatible.  net403 was computed.  net45 is compatible.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 is compatible.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on ProtoPromise:

Package Downloads
ProtoPromise.UnityHelpers.2018.3

ProtoPromise helpers for UnityEngine.
ProtoPromise.UnityHelpers.2023.1

ProtoPromise helpers for UnityEngine.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.0.2 145 4/12/2024
3.0.1 160 4/6/2024
3.0.0 238 3/18/2024
2.7.0 611 2/11/2024
2.6.1 1,037 10/22/2023
2.6.0 347 10/2/2023
2.5.4 583 6/17/2023
2.5.3 578 6/9/2023
2.5.2 539 6/5/2023
2.5.1 518 5/27/2023
2.5.0 552 5/15/2023
2.4.1 751 2/6/2023
2.4.0 807 12/23/2022
2.3.0 951 9/25/2022
2.2.0 726 8/6/2022
2.1.0 707 6/20/2022
2.0.2 740 4/25/2022
2.0.1 755 4/7/2022
2.0.0 747 3/7/2022

Enhancements:

- Added overloads accepting `ReadOnlySpan<T>` parameter.
   - `CancelationSource.New`
   - `AsyncEnumerable<T>.Merge`
   - `Promise(<T>).{All(Settled), Race(WithIndex), First(WithIndex)}`
- Added `CancelationToken.TryRegisterWithoutImmediateInvoke<TCancelable>` API.
- Added `AsyncSemaphore.EnterScopeAsync(CancelationToken)` and `AsyncSemaphore.EnterScope(CancelationToken)` overloads.

Fixes:

- Enumerator is properly disposed in `Promise.ParallelForEach`.

Optimizations:

- Improved performance and reduced memory of promises and types that use promises.
- Async synchronization primitives use spin lock instead of full Monitor lock.

Breaking Changes:

- Removed support for runtimes older than .Net Standard 2.0.
- Removed deprecated and useless APIs.
   - `Deferred.{(Try)ReportProgress, (Try)Cancel, State, Retain, Release, New(CancelationToken)}`
   - `Promise.{Progress, AwaitWithProgress, NewDeferred(CancelationToken), Wait(TimeSpan), Retain, Release, New<T>, New<TCapture, T>, Rejected<T, TReject>, Canceled<TCancel>, Canceled<T, TCancel>, CancelException<T>}`
   - `Promise<T>.{WaitForResult(TimeSpan, out T), Retain, Release, AllNonAlloc, Canceled<TCancel>, NewDeferred(CancelationToken)}`
   - `CanelationRegistration.Unregister`
   - `CancelationSource.(Try)Cancel<TReason>`
   - `CancelationToken.{Retain, CancelationValueType, CancelationValue, TryGetCancelationValueAs<T>}`
   - `PoolType`
   - `Promise.Config.{ObjectPooling, WarningHandler}`
   - `Promise.Manager.{HandleCompletes, HandleCompletesAndProgress, HandleProgress, LogWarning}`
   - `ReasonContainer`
   - `Promise.ResultContainer.{RejectReason, RejectContainer, CancelContainer}`
   - `Promise<T>.ResultContainer.{Result, RejectReason, RejectContainer, CancelContainer}`
   - `AsyncMonitor.{WaitAsync(AsyncLock.Key, CancelationToken), Wait(AsyncLock.Key, CancelationToken)}`
   - `PromiseYielder.WaitOneFrame(MonoBehaviour)`
   - `UnhandledException.{ValueType, TryGetValueAs<T>}`
   - `CanceledException.{ValueType, Value, TryGetValueAs<T>}`
- Removed `Promise(<T>).{ContinueFunc, ContinueAction}` delegates.
- `Promise(<T>).ContinueWith` parameter delegate types changed to standard `System.Action` and `System.Func<>`.
- Removed `IRetainable` interface.
- `AsyncReaderWriterLock` upgrade key type changed from `AsyncReaderWriterLock.WriterKey` to `AsyncReaderWriterLock.UpgradedWriterKey`.
- `Proto.Promises.Async.CompilerServices` namespace changed to `Proto.Promises.CompilerServices`.
- `PromiseMethodBuilder(<T>)` types renamed to `AsyncPromiseMethodBuilder(<T>)`.
- Moved `Proto.Promises.Extensions` to `Proto.Promises.TaskExtensions` and `Proto.Promises.CancellationTokenExtensions`