ProtoPromise 3.3.0

Requires NuGet 2.5 or higher.

dotnet add package ProtoPromise --version 3.3.0                
NuGet\Install-Package ProtoPromise -Version 3.3.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.3.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add ProtoPromise --version 3.3.0                
#r "nuget: ProtoPromise, 3.3.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.3.0

// Install ProtoPromise as a Cake Tool
#tool nuget:?package=ProtoPromise&version=3.3.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
  • Structured concurrency
  • async/await support and .Then API
  • Thread safe
  • Easily switch to foreground or background context
  • Circular await detection
  • Full causality traces
  • 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 was computed.  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 is compatible.  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.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  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.3.0 116 1/27/2025
3.2.0 405 11/3/2024
3.1.1 758 8/17/2024
3.1.0 227 6/30/2024
3.0.2 649 4/12/2024
3.0.1 286 4/6/2024
3.0.0 307 3/18/2024
2.7.0 1,149 2/11/2024
2.6.1 1,100 10/22/2023
2.6.0 389 10/2/2023
2.5.4 619 6/17/2023
2.5.3 614 6/9/2023
2.5.2 576 6/5/2023
2.5.1 556 5/27/2023
2.5.0 593 5/15/2023
2.4.1 789 2/6/2023
2.4.0 847 12/23/2022
2.3.0 990 9/25/2022
2.2.0 767 8/6/2022
2.1.0 745 6/20/2022
2.0.2 777 4/25/2022
2.0.1 796 4/7/2022
2.0.0 793 3/7/2022

Enhancements:

- Added `Proto.Timers`.
- `Timer` and `TimerFactory`
- Added `Promise.Delay` APIs.
- Added `Promise(<T>).WaitAsync` APIs with timeouts.
- Added delayed cancelation APIs to `CancelationSource`.
- `CancelationSource.New(TimeSpan, (optional) TimerFactory, (optional) linked token(s))`
- `CancelationSource.CancelAfter(TimeSpan)`
- Added `CancelationToken(bool)` constructor.
- Added `CancelationToken.RegisterWithoutImmediateInvoke` APIs.

Optimizations:

- `Promise(<T>).ConfigureAwait(ContinuationOptions)` consumes zero memory if `Promise.Config.AsyncFlowExecutionContextEnabled` is disabled (which is the default state).
- Reduced memory of `async Promise(<T>)`.
- Reduced memory of async synchronization primitives
- Reduced memory of `Promise.ParallelFor*` APIs.
- Reduced memory of `Channel`s.
- Optimized object pool contention.
- Internally avoid cost of zeroing types that contain no references.
- Split `Promise(<T>).ContinueWith` methods without a `CancelationToken` parameter to avoid the cost of the token when it's not needed.
- Reduced memory and increased speed of `AsyncLazy<T>` when the factory is invoked.
- No longer pool memory allocated from `AsyncLazy<T>`.

Deprecated:

- `Promise(<T>).{Then, Catch, CatchCancelation}` APIs accepting a `CancelationToken` parameter. (Prefer `WaitAsync` followed by the same API without the token.)
- Deprecated `CancelationSource.{IsValid, TryCancel, TryDispose}`. (Prefer `!= default` and methods without `Try` prefix.)
- Deprecated `CancelationToken.{TryRegister, TryRegisterWithoutImmediateInvoke}`. (Prefer `CanBeCanceled` and methods without `Try` prefix.)
- Deprecated `Promise(<T>).Deferred.{IsValid*, Try*}` APIs. (Prefer `!= default`.)
- Deprecated `Promise(<T>).IsValid`.

Misc:

- Changed behavior of `CancelationSource.Cancel` to not throw if it's called more than once.
- Changed behavior of `CancelationSource`, `Promise(<T>).Deferred`, `Channel(Reader/Writer)` to throw `NullReferenceException` if it's default.