ProtoPromise 2.5.0
See the version list below for details.
Requires NuGet 2.5 or higher.
dotnet add package ProtoPromise --version 2.5.0
NuGet\Install-Package ProtoPromise -Version 2.5.0
<PackageReference Include="ProtoPromise" Version="2.5.0" />
paket add ProtoPromise --version 2.5.0
#r "nuget: ProtoPromise, 2.5.0"
// Install ProtoPromise as a Cake Addin #addin nuget:?package=ProtoPromise&version=2.5.0 // Install ProtoPromise as a Cake Tool #tool nuget:?package=ProtoPromise&version=2.5.0
Robust and efficient library for management of asynchronous operations.
- Allocation-free async operations
- Cancelable operations with custom allocation-free CancelationToken/Source
- Progress with universal automatic or manual normalization
- Full causality traces
- Interoperable with Tasks and Unity's Coroutines
- Thread safe
- .Then API and async/await
- Easily switch to foreground or background context
- Combine async operations
- Circular await detection
- CLS compliant
This library was built to work in all C#/.Net ecosystems, including Unity, Mono, .Net Framework, .Net Core, UI frameworks, and AOT compilation. It is CLS compliant, so it is not restricted to only C#, and will work with any .Net language.
ProtoPromise conforms to the Promises/A+ Spec as far as is possible with C# (using static typing instead of dynamic), and further extends it to support Cancelations and Progress.
This library took inspiration from ES6 Promises (javascript), RSG Promises (C#), uPromise (C#/Unity), TPL, and UniTask (C#/Unity).
Product | Versions 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. |
-
.NETCoreApp 2.1
- Microsoft.Bcl.AsyncInterfaces (>= 6.0.0)
-
.NETFramework 3.5
- No dependencies.
-
.NETFramework 4.0
- No dependencies.
-
.NETFramework 4.5
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
.NETFramework 4.7
- Microsoft.Bcl.AsyncInterfaces (>= 6.0.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
.NETStandard 2.0
- Microsoft.Bcl.AsyncInterfaces (>= 6.0.0)
- System.Threading.Tasks.Extensions (>= 4.5.4)
-
.NETStandard 2.1
- No dependencies.
-
net5.0
- No dependencies.
-
net6.0
- No dependencies.
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.2.0 | 166 | 11/3/2024 |
3.1.1 | 564 | 8/17/2024 |
3.1.0 | 215 | 6/30/2024 |
3.0.2 | 639 | 4/12/2024 |
3.0.1 | 276 | 4/6/2024 |
3.0.0 | 299 | 3/18/2024 |
2.7.0 | 1,050 | 2/11/2024 |
2.6.1 | 1,092 | 10/22/2023 |
2.6.0 | 381 | 10/2/2023 |
2.5.4 | 613 | 6/17/2023 |
2.5.3 | 608 | 6/9/2023 |
2.5.2 | 570 | 6/5/2023 |
2.5.1 | 550 | 5/27/2023 |
2.5.0 | 584 | 5/15/2023 |
2.4.1 | 783 | 2/6/2023 |
2.4.0 | 841 | 12/23/2022 |
2.3.0 | 982 | 9/25/2022 |
2.2.0 | 756 | 8/6/2022 |
2.1.0 | 737 | 6/20/2022 |
2.0.2 | 769 | 4/25/2022 |
2.0.1 | 788 | 4/7/2022 |
2.0.0 | 785 | 3/7/2022 |
Enhancements:
- Added `AsyncLazy` type.
- Added more async synchronization primitives in the `Proto.Promises.Threading` namespace:
- `AsyncReaderWriterLock`
- `AsyncManualResetEvent`
- `AsyncAutoResetEvent`
- `AsyncSemaphore`
- `AsyncCountdownEvent`
- `AsyncConditionVariable`
- Added `AsyncMonitor.TryEnter(Async)` accepting `CancelationToken` parameter.
- Added APIs to wait for promise result without throwing. These get the result wrapped in `Promise(<T>).ResultContainer`, instead of throwing if the promise was rejected or canceled.
- `Promise(<T>).AwaitNoThrow()`
- `Promise(<T>).AwaitWithProgressNoThrow()`.
- `Promise.(Try)WaitNoThrow`
- `Promise<T>.(Try)WaitForResultNoThrow`.
- Added `Promise(<T>).ResultContainer.RethrowIfRejectedOrCanceled`.
- Added `Promise.SwitchToForegroundAwait`, `Promise.SwitchToBackgroundAwait`, and `Promise.SwitchToContextAwait` for more efficient context switch in `async` functions.
Optimizations:
- `Promise(<T>).Canceled()` now uses a singleton reference, instead of accessing the object pool/allocating.
- Exposed `Promise.Manager.ThreadStaticSynchronizationContext` for efficient synchronous `WaitAsync`, etc calls.
- Fixed a progress performance degradation when an uncommon race condition occurs.
- Optimized the common case in progress reports.
Fixes:
- Fixed `Promise.All/Merge` progress when a promise is canceled.
Deprecated:
- deprecated `Promise.NewDeferred(CancelationToken)`. Use `Promise.NewDeferred()` and `CancelationToken.Register` to cancel the deferred directly.
- deprecated `Promise.Wait(int)`, `Promise<T>.WaitForResult(int, out T)`, `AsyncMonitor.WaitAsync(AsyncLock.Key, CancelationToken)`. Use methods with `Try`-prefixed of the same name.
Minor Changes:
- `AsyncLock.LockAsync(CancelationToken)` returns a canceled promise if the token is already canceled (and the synchronous version throws `CanceledException`).
- `Promise(<T>).ResultContainer.Rethrow...` now throws the actual exception instead of a `RethrowException`.
Misc:
- Relaxed `Promise(<T>).ResultContainer` from `readonly ref struct` to `readonly struct`.
- Exceptions from `PromiseSynchronizationContext.Send` are now wrapped in `System.Exception` and re-thrown in old runtime.
- Various xml documentation fixes.