Akka.Cluster.Sharding 1.3.9-beta

Sharded actors with managed lifecycle for Akka.NET cluster

This is a prerelease version of Akka.Cluster.Sharding.
There is a newer version of this package available.
See the version list below for details.
Install-Package Akka.Cluster.Sharding -Version 1.3.9-beta
dotnet add package Akka.Cluster.Sharding --version 1.3.9-beta
<PackageReference Include="Akka.Cluster.Sharding" Version="1.3.9-beta" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Akka.Cluster.Sharding --version 1.3.9-beta
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Release Notes

Maintenance Release for Akka.NET 1.3**
Akka.NET v1.3.9 features some major changes to Akka.Cluster.Sharding, additional Akka.Streams stages, and some general bug fixes across the board.
Akka.Cluster.Sharding Improvements**
The [Akka.Cluster.Sharding documentation](http://getakka.net/articles/clustering/cluster-sharding.html#quickstart) already describes some of the major changes in Akka.NET v1.3.9, but we figured it would be worth calling special attention to those changes here.
Props Factory for Entity Actors**
> In some cases, the actor may need to know the `entityId` associated with it. This can be achieved using the `entityPropsFactory` parameter to `ClusterSharding.Start` or `ClusterSharding.StartAsync`. The entity ID will be passed to the factory as a parameter, which can then be used in the creation of the actor.
In addition to the existing APIs we've always had for defining sharded entities via `Props`, Akka.NET v1.3.9 introduces [a new method overload for `Start`](http://getakka.net/api/Akka.Cluster.Sharding.ClusterSharding.html#Akka_Cluster_Sharding_ClusterSharding_Start_System_String_System_Func_System_String_Akka_Actor_Props__Akka_Cluster_Sharding_ClusterShardingSettings_Akka_Cluster_Sharding_ExtractEntityId_Akka_Cluster_Sharding_ExtractShardId_) and [`StartAsync`](http://getakka.net/api/Akka.Cluster.Sharding.ClusterSharding.html#Akka_Cluster_Sharding_ClusterSharding_StartAsync_System_String_System_Func_System_String_Akka_Actor_Props__Akka_Cluster_Sharding_ClusterShardingSettings_Akka_Cluster_Sharding_ExtractEntityId_Akka_Cluster_Sharding_ExtractShardId_) which allows users to pass in the `entityId` of each entity actor as a constructor argument to those entities when they start.
For example:
```
var anotherCounterShard = ClusterSharding.Get(Sys).Start(
                       typeName: "AnotherCounter",
                       entityProps: Props.Create<AnotherCounter>(),
                       typeName: AnotherCounter.ShardingTypeName,
                       entityPropsFactory: entityId => AnotherCounter.Props(entityId),
                       settings: ClusterShardingSettings.Create(Sys),
                       extractEntityId: Counter.ExtractEntityId,
                       extractShardId: Counter.ExtractShardId);
```
This will give you the opportunity to pass in the `entityId` for each actor as a constructor argument into the `Props` of your entity actor and possibly other use cases too.
Improvements to Starting and Querying Existing Shard Entity Types**
Two additional major usability improvements to Cluster.Sharding come from some API additions and changes.
The first is that it's now possible to look up all of the currently registered shard types via the [`ClusterSharding.ShardTypeNames` property](http://getakka.net/api/Akka.Cluster.Sharding.ClusterSharding.html#Akka_Cluster_Sharding_ClusterSharding_ShardTypeNames). So long as a `ShardRegion` of that type has been started in the cluster, that entity type name will be added to the collection exposed by this property.
The other major usability improvement is a change to the `ClusterSharding.Start` property itself. Historically, you used to have to know whether or not the node you wanted to use sharding on was going to be hosting shards (call `ClusterSharding.Start`) or simply communicated with shards hosted on a different cluster role type (call `ClusterSharding.StartProxy`). Going forward, it's safe to call `ClusterSharding.Start` on any node and you will either receive an `IActorRef` to active `ShardRegion` or a `ShardRegion` running in "proxy only" mode; this is determined by looking at the `ClusterShardingSettings` and determining if the current node is in a role that is allowed to host shards of this type.
[Akka.Cluster.Sharding: Sharding API Updates](https://github.com/akkadotnet/akka.net/pull/3524)
[Akka.Cluster.Sharding: sharding rebalance fix](https://github.com/akkadotnet/akka.net/pull/3518)
[Akka.Cluster.Sharding: log formatting fix](https://github.com/akkadotnet/akka.net/pull/3554)
[Akka.Cluster.Sharding: `RestartShard` escapes into userspace](https://github.com/akkadotnet/akka.net/pull/3509)
Akka.Streams Additions and Changes**
In Akka.NET v1.3.9 we've added some new built-in stream stages and API methods designed to help improve developer productivity and ease of use.
[Akka.Streams: add CombineMaterialized method to Source](https://github.com/akkadotnet/akka.net/pull/3489)
[Akka.Streams:
KillSwitches: flow stage from CancellationToken](https://github.com/akkadotnet/akka.net/pull/3568)
[Akka.Streams: Port KeepAliveConcat and UnfoldFlow](https://github.com/akkadotnet/akka.net/pull/3560)
[Akka.Streams: Port PagedSource & IntervalBasedRateLimiter](https://github.com/akkadotnet/akka.net/pull/3570)
Other Updates, Additions, and Bugfixes**
[Akka.Cluster: cluster coordinated leave fix for empty cluster](https://github.com/akkadotnet/akka.net/pull/3516)
[Akka.Cluster.Tools: bumped ClusterClient message drop log messages from DEBUG to WARNING](https://github.com/akkadotnet/akka.net/pull/3513)
[Akka.Cluster.Tools: Singleton - confirm TakeOverFromMe when singleton already in oldest state](https://github.com/akkadotnet/akka.net/pull/3553)
[Akka.Remote: RemoteWatcher race-condition fix](https://github.com/akkadotnet/akka.net/pull/3519)
[Akka: fix concurrency bug in CircuitBreaker](https://github.com/akkadotnet/akka.net/pull/3505)
[Akka: Fixed ReceiveTimeout not triggered in some case when combined with NotInfluenceReceiveTimeout messages](https://github.com/akkadotnet/akka.net/pull/3555)
[Akka.Persistence: Optimized recovery](https://github.com/akkadotnet/akka.net/pull/3549)
[Akka.Persistence: Allow persisting events when recovery has completed](https://github.com/akkadotnet/akka.net/pull/3366)
To [see the full set of changes for Akka.NET v1.3.9, click here](https://github.com/akkadotnet/akka.net/milestone/27).
| COMMITS | LOC+ | LOC- | AUTHOR |
| --- | --- | --- | --- |
| 28 | 2448 | 5691 | Aaron Stannard |
| 11 | 1373 | 230 | zbynek001 |
| 8 | 4590 | 577 | Bartosz Sypytkowski |
| 4 | 438 | 99 | Ismael Hamed |
| 4 | 230 | 240 | Sean Gilliam |
| 2 | 1438 | 0 | Oleksandr Bogomaz |
| 1 | 86 | 79 | Nick Polideropoulos |
| 1 | 78 | 0 | v1rusw0rm |
| 1 | 4 | 4 | Joshua Garnett |
| 1 | 32 | 17 | Jarl Sveinung Flø Rasmussen |
| 1 | 27 | 1 | Sam13 |
| 1 | 250 | 220 | Maxim Cherednik |
| 1 | 184 | 124 | Josh Taylor |
| 1 | 14 | 0 | Peter Shrosbree |
| 1 | 1278 | 42 | Marc Piechura |
| 1 | 1 | 1 | Vasily Kirichenko |
| 1 | 1 | 1 | Samuel Kelemen |
| 1 | 1 | 1 | Nyola Mike |
| 1 | 1 | 1 | Fábio Beirão |

NuGet packages (4)

Showing the top 4 NuGet packages that depend on Akka.Cluster.Sharding:

Package Downloads
wyvern.entity
Package Description
Petabridge.Cmd.Cluster.Sharding
Akka.Cluster.Sharding Petabridge.Cmd palettes for shard management and monitoring.
Akkling.Cluster.Sharding
F# wrapper library for Akka.NET cluster sharding module.
Akkatecture.Clustering
clustering library for akkatecture to enable distributed scenarios

GitHub repositories (2)

Showing the top 2 popular GitHub repositories that depend on Akka.Cluster.Sharding:

Repository Stars
Lutando/Akkatecture
a cqrs and event sourcing framework for dotnet core using akka.net
Horusiath/AkkaCQRS
Event sourcing example build on Akka.NET with persistence plugin

Version History

Version Downloads Last updated
1.4.9 608 7/21/2020
1.4.8 3,798 6/17/2020
1.4.7 1,650 5/27/2020
1.4.6 2,127 5/12/2020
1.4.5 1,729 4/29/2020
1.4.4 4,550 3/31/2020
1.4.3 1,350 3/18/2020
1.4.2 1,401 3/13/2020
1.4.1 3,480 3/11/2020
1.4.1-rc3 142 3/10/2020
1.4.1-rc2 66 3/10/2020
1.4.1-rc1 384 2/28/2020
1.4.0-beta4 1,622 1/28/2020
1.4.0-beta3 4,800 10/30/2019
1.4.0-beta2 2,929 9/23/2019
1.4.0-beta1 1,654 7/19/2019
1.4.0-beta 113 10/30/2019
1.3.18-beta 1,736 3/9/2020
1.3.17-beta 3,987 12/20/2019
1.3.16-beta 2,046 11/14/2019
1.3.15-beta 3,574 9/23/2019
1.3.14-beta 4,252 7/30/2019
1.3.13-beta 6,489 4/30/2019
1.3.12-beta 10,176 3/14/2019
1.3.11-beta 8,842 12/18/2018
1.3.10-beta 3,298 11/2/2018
1.3.9-beta68 26,839 8/23/2018
1.3.9-beta67 226 8/23/2018
1.3.9-beta 232 8/30/2018
1.3.8-beta66 6,887 6/5/2018
1.3.8-beta65 306 6/5/2018
1.3.7-beta64 784 5/15/2018
1.3.7-beta63 303 5/15/2018
1.3.6-beta62 2,292 4/17/2018
1.3.6-beta61 276 4/17/2018
1.3.5-beta60 5,835 2/22/2018
1.3.5-beta59 307 2/22/2018
1.3.4-beta58 500 2/1/2018
1.3.4-beta57 362 2/1/2018
1.3.3-beta56 498 1/19/2018
1.3.3-beta55 346 1/19/2018
1.3.2-beta54 17,930 10/21/2017
1.3.2-beta53 307 10/21/2017
1.3.2-beta 346 10/24/2017
1.3.1-beta52 732 9/5/2017
1.3.1-beta51 344 9/5/2017
1.3.0-beta50 336 8/18/2017
1.3.0-beta48 325 8/17/2017
1.3.0-beta47 337 8/17/2017
1.3.0-beta46 374 8/11/2017
1.2.3.43-beta 1,199 7/10/2017
1.2.3.41-beta 335 7/10/2017
1.2.2.40-beta 379 6/28/2017
1.2.2.39-beta 342 6/28/2017
1.2.1.38-beta 362 6/23/2017
1.2.1.37-beta 344 6/23/2017
1.2.0.36-beta 9,874 4/13/2017
1.2.0.35-beta 590 4/13/2017
1.2.0.34-beta 361 4/12/2017
1.2.0.33-beta 376 4/12/2017
1.1.3.32-beta 1,384 1/23/2017
1.1.3.31-beta 374 1/23/2017
1.1.2.30-beta 1,285 9/22/2016
1.1.2.29-beta 362 9/22/2016
1.1.1.28-beta 500 7/16/2016
1.1.1.27-beta 430 7/16/2016
1.1.0.26-beta 466 7/7/2016
1.0.8.25-beta 1,420 4/26/2016
1.0.8.24-beta 443 4/26/2016
1.0.7.18-beta 485 4/6/2016
Show less