Skip to content

Latest commit

 

History

History
1163 lines (883 loc) · 62.9 KB

RELEASE_NOTES.md

File metadata and controls

1163 lines (883 loc) · 62.9 KB
Raw

1.1.2 September 21 2016

Maintenance release for Akka.NET v1.1

Akka.NET 1.1.2 introduces some exciting developments for Akka.NET users.

Mono Support and Improved IPV4/6 Configuration First, Akka.NET 1.1.2 is the first release of Akka.NET to be production-certified for Mono. We've made some changes to Akka.Remote, in particular, to design it to work within some of the confines of Mono 4.4.2. For instance, we now support the following HOCON configuration value for the default Helios TCP transport:

 helios.tcp {
	  # Omitted for brevity
      transport-protocol = tcp

      port = 2552

      hostname = ""

	  public-hostname = ""

	  dns-use-ipv6 = false
	  enforce-ip-family = false
}

helios.tcp.enforce-ip-family is a new setting added to the helios.tcp transport designed to allow Akka.Remote to function in environments that don't support IPV6. This includes Mono 4.4.2, Windows Azure WebApps, and possibly others. When this setting is turned on and dns-use-ipv6 = false, all sockets will be forced to use IPV4 only instead of dual mode. If this setting is turned on and dns-use-ipv6 = true, all sockets opened by the Helios transport will be forced to use IPV6 instead of dual-mode.

Currently, as of Mono 4.4.2, this setting is turned on by default. Mono 4.6, when it's released, will allow dual-mode to work consistently again in the future.

We run the entire Akka.NET test suite on Mono and all modules pass.

Akka.Cluster Downing Providers We've added a new feature to Akka.Cluster known as a "downing provider" - this is a pluggable strategy that you can configure via HOCON to specify how nodes in your Akka.NET cluster may automatically mark unreachable nodes as down.

Out of the box Akka.Cluster only provides the default "auto-down" strategy that's been included as part of Akka.Cluster in the past. However, you can now subclass the Akka.Cluster.IDowningProvider interface to implement your own strategies, which you can then load through HOCON:

# i.e.: akka.cluster.downing-provider-class = "Akka.Cluster.Tests.FailingDowningProvider, Akka.Cluster.Tests"
akka.cluster.downing-provider-class = "Fully-qualified-type-name, Assembly"

Other Fixes We've also made significant improvements to the Akka.NET scheduler, more than doubling its performance and an significantly decreasing its memory allocation and garbage collection; updated Akka.Streams; fixed bugs in Akka.Cluster routers; and more. You can read the full list of changes in 1.1.2 here.

COMMITS LOC+ LOC- AUTHOR
16 3913 1440 ravengerUA
9 2323 467 Aaron Stannard
9 12568 2865 Marc Piechura
4 12 5 Michael Kantarovsky
3 381 196 Bartosz Sypytkowski
2 99 0 rogeralsing
2 359 17 Chris Constantin
2 29 6 Denys Zhuravel
2 11 11 Ismael Hamed
1 74 25 mrrd
1 5 2 Szymon Kulec
1 48 65 alexpantyukhin
1 3 2 Tamas Vajk
1 2 0 Julien Adam
1 121 26 andrey.leskov
1 1020 458 Sean Gilliam
1 1 1 Maciej Misztal

1.1.1 July 15 2016

Maintenance release for Akka.NET v1.1

Akka.NET 1.1.1 addresses a number of bugs and issues reported by end users who made the upgrade from Akka.NET 1.0.* to Akka.NET 1.1.

DNS improvements The biggest set of fixes included in Akka.NET 1.1.1 deal with how the Helios transport treats IPV6 addresses and performs DNS resolution. In Akka.NET 1.0.* Helios only supported IPV4 addresses and would use that as the default for DNS. In Akka.NET 1.1 we upgraded to using Helios 2.1, which supports both IPV6 and IPV4, but changed the default DNS resolution strategy to use IPV6. This caused some breakages for users who were using the public-hostname setting inside Helios in combination with a hostname value that used an IPV4 address.

This is now fixed - Akka.NET 1.1.1 uses Helios 2.1.2 which defaults back to an IPV4 DNS resolution strategy for both inbound and outbound connections. We've also fixed the way we encode and format IPV6 addresses into ActorPath and Address string representations (although we still have an issue with parsing IPV6 from HOCON.)

If you need to use IPV6 for DNS resolution, you can enable it by changing the following setting:

akka.remote.helios.tcp.dns-use-ipv6 = true

You can see the full list of Akka.NET 1.1.1 changes here.

1.1.0 July 05 2016

Feature Release for Akka.NET

In Akka.NET 1.1 we introduce the following major changes:

  • Akka.Cluster is no longer in beta; it is released as a fully stable module with a frozen API that is ready for production use.
  • Akka.Remote now has a new Helios 2.1 transport that is up to 5x faster than the previous implementation and with tremendously lower memory consumption.
  • The actor mailbox system has been replaced with the MailboxType system, which standardizes all mailbox implementations on a common core and instead allows for pluggable IMessageQueue implementations. This will make it easier to develop user-defined mailboxes and also has the added benefit of reducing all actor memory footprints by 34%.
  • The entire router system has been updated, including support for new "controller" actors that can be used to adjust a router's routing table in accordance to external events (i.e. a router that adjusts whom it routes to based on CPU utilization, which will be implemented in Akka.Cluster.Metrics).

Full list of Akka.NET 1.1 fixes and changes

API Changes There have been a couple of important API changes which will affect end-users upgrading from Akka.NET versions 1.0.*.

First breaking change deals with the PriorityMailbox base class, used by developers who need to prioritize specific message types ahead of others.

All user-defined instances of this type must now include the following constructor in order to work (using an example from Akka.NET itself:)

public class IntPriorityMailbox : UnboundedPriorityMailbox
{
    protected override int PriorityGenerator(object message)
    {
        return message as int? ?? Int32.MaxValue;
    }

    public IntPriorityMailbox(Settings settings, Config config) : base(settings, config)
    {
    }
}

There must be a MyMailboxType(Settings settings, Config config) constructor on all custom mailbox types going forward, or a ConfigurationException will be thrown when trying to instantiate an actor who uses the mailbox type.

Second breaking change deals with Akka.Cluster itself. In the past you could access all manner of data from the ClusterReadView class (accessed via the Cluster.ReadView property) - such as the addresses of all other members, who the current leader was, and so forth.

Going forward ClusterReadView is now marked as internal, but if you need access to any of this data you can access the Cluster.State property, which will return a CurrentClusterState object. This contains most of the same information that was previously available on ClusterReadView.

Akka.Streams Another major part of Akka.NET 1.1 is the introduction of Akka.Streams, a powerful library with a Domain-Specific Language (DSL) that allows you to compose Akka.NET actors and workflows into streams of events and messages.

As of 1.1 Akka.Streams is now available as a beta module on NuGet.

We highly recommend that you read the Akka.Streams Quick Start Guide for Akka.NET as a place to get started.

Akka.Persistence.Query A second beta module is also now available as part of Akka.NET 1.1, Akka.Persistence.Query - this module is built on top of Akka.Streams and Akka.Persistence and allows users to query ranges of information directly from their underlying Akka.Persistence stores for more powerful types of reads, aggregations, and more.

Akka.Persistence.Query is available for all SQL implementations of Akka.Persistence and will be added to our other Akka.Persistence plugins shortly thereafter.

Thank you! Thanks for all of your patience and support as we worked to deliver this to you - it's been a tremendous amount of work but we really appreciate the help of all of the bug reports, Gitter questions, StackOverflow questions, and testing that our users have done on Akka.NET and specifically, Akka.Cluster over the past two years. We couldn't have done this without you.

23 contributors since release v1.0.8

COMMITS LOC+ LOC- AUTHOR
133 38124 7835 Silv3rcircl3
112 25826 10493 Chris Constantin
70 45449 11556 Bartosz Sypytkowski
44 22804 13971 ravengerUA
40 9811 6396 Aaron Stannard
12 9539 6619 Marc Piechura
6 1692 959 Sean Gilliam
4 448 0 alexpantyukhin
3 772 4 maxim.salamatko
3 3 382 Danthar
2 40 46 Vagif Abilov
1 91 103 rogeralsing
1 3 3 Jeff Cyr
1 219 44 Michael Kantarovsky
1 2 1 Juergen Hoetzel
1 19 8 tstojecki
1 187 2 Bart de Boer
1 178 0 Willem Meints
1 17 1 Kamil Wojciechowski
1 120 7 JeffCyr
1 11 7 corneliutusnea
1 1 1 Tamas Vajk
1 0 64 annymsMthd

1.0.8 April 26 2016

Maintenance release for Akka.NET v1.0.7

Fixes an issue with the 1.0.7 release where the default settings for Akka.Persistence changed and caused potential breaking changes for Akka.Persistence users. Those changes have been reverted back to the same values as previous versions.

General fixes:

Commit Stats for v1.0.8

COMMITS LOC+ LOC- AUTHOR
4 240 59 Aaron Stannard
3 268 1 Danthar
3 189 2810 Silv3rcircl3
2 204 4 Willem Meints
2 161 108 Bartosz Sypytkowski
2 101 24 Sean Gilliam
1 25 16 zbynek001

1.0.7 April 4 2016

Maintenance release for Akka.NET v1.0.6 The biggest changes in Akka.NET 1.0.7 have been made to Akka.Persistence, which is now designed to match the final stable release version in JVM Akka 2.4. Akka.Persistence is on-target to exit beta and become a fully mature module as of Akka.NET 1.5, due in May/June timeframe.

A quick note about 1.5 - JSON.NET will be replaced by Wire as the default serializer going forward, so if you want to be forward-compatible with 1.5 you will need to switch to using Wire today. Learn how to switch to using Wire as the default Akka.NET serializer.

If you install 1.0.7 you may see the following warning appear:

NewtonSoftJsonSerializer has been detected as a default serializer. It will be obsoleted in Akka.NET starting from version 1.5 in the favor of Wire for more info visit: http://getakka.net/docs/Serialization#how-to-setup-wire-as-default-serializer If you want to suppress this message set HOCON {configPath} config flag to on.

This release also fixes some issues with the Cluster.Tools and Cluster.Sharding NuGet packages, which weren't versioned correctly in previous releases.

Fixes & Changes - Akka.NET Core

Fixes & Changes - Akka.Remote, Akka.Cluster, Et al

Fixes & Changes - Akka.Persistence

Commit Stats for v1.0.7

COMMITS LOC+ LOC- AUTHOR
12 1718 2213 Aaron Stannard
11 2187 2167 Silv3rcircl3
7 433 75 JeffCyr
6 2 1127 Danthar
6 10383 3054 Chris Constantin
3 510 25 maxim.salamatko
3 5 3 Christopher Martin
2 53 65 rogeralsing
2 50 1 mukulsinghsaini
2 2738 2035 Sean Gilliam
2 25 4 Bartosz Sypytkowski
2 2 2 utcnow
2 14 13 zbynek001
2 130 126 annymsMthd
1 58 0 Denis Kostikov
1 48 43 voltcode
1 213 66 Alex Koshelev
1 2 2 Tamas Vajk
1 2 2 Marc Piechura
1 2 1 Juergen Hoetzel
1 19 8 tstojecki
1 13 13 Willie Ferguson
1 1 1 ravengerUA

1.0.6 January 18 2016

Maintenance release for Akka.NET v1.0.5 This patch consists of many bug fixes, performance improvements, as well as the addition of two brand new alpha modules for Akka.Cluster users.

Akka.Cluster.Tools and Akka.Cluster.Sharding The biggest part of this release is the addition of Akka.Cluster.Tools and Akka.Cluster.Sharding, both of which are available now as pre-release packages on NuGet.

PM> Install-Package Akka.Cluster.Tools -pre

and

PM> Install-Package Akka.Cluster.Sharding -pre

Respectively, these two packages extend Akka.Cluster to do the following:

  1. Distributed pub/sub (Akka.Cluster.Tools)
  2. ClusterClient - subscribe to changes in cluster availability without actually being part of the cluster itself. (Akka.Cluster.Tools)
  3. ClusterSingleton - guarantee a single instance of a specific actor throughout the cluster. (Akka.Cluster.Tools)
  4. Sharding - partition data into durable stores (built on top of Akka.Persistence) in a manner that is fault-tolerant and recoverable across thecluster. (Akka.Cluster.Sharding)

Check out the documentation for more details!

Fixes & Changes - Akka.NET Core

Fixes & Changes - Akka.Remote & Akka.Cluster It should be noted that we've improved the throughput from Akka.NET v1.0.5 to 1.0.6 by a factor of 8

Fixes & Changes - Akka.Persistence

A special thanks to all of our contributors for making this happen! 18 contributors since release v1.0.5

COMMITS LOC+ LOC- AUTHOR
22 3564 28087 Aaron Stannard
15 1710 1303 rogeralsing
6 569 95 Silv3rcircl3
6 53594 4417 Bartosz Sypytkowski
5 1786 345 Sean Gilliam
3 786 159 maxim.salamatko
2 765 277 JeffCyr
2 44 53 Chris Constantin
2 14 2 Simon Anderson
1 84 4 Bart de Boer
1 6051 27 danielmarbach
1 6 2 tstojecki
1 3 5 Ralf1108
1 27 0 Andrew Skotzko
1 2 2 easuter
1 2 1 Danthar
1 182 0 derwasp
1 179 0 Onat Yiğit Mercan

1.0.5 December 3 2015

Maintenance release for Akka.NET v1.0.4 This release is a collection of bug fixes, performance enhancements, and general improvements contributed by 29 individual contributors.

Fixes & Changes - Akka.NET Core

Fixes & Changes - Akka.Remote, Akka.Cluster

Fixes & Changes - Akka.Persistence

A special thanks to all of our contributors, organized below by the number of changes made:

23369 5258 18111 Aaron Stannard 18827 16329 2498 Bartosz Sypytkowski 11994 9496 2498 Steffen Forkmann 6031 4637 1394 maxim.salamatko 1987 1667 320 Graeme Bradbury 1556 1149 407 Sean Gilliam 1118 1118 0 moliver 706 370 336 rogeralsing 616 576 40 Marek Kadek 501 5 496 Alex Koshelev 377 269 108 Jeff Cyr 280 208 72 willieferguson 150 98 52 Christian Palmstierna 85 63 22 Willie Ferguson 77 71 6 Emil Ingerslev 66 61 5 Grover Jackson 60 39 21 Alexander Pantyukhin 56 33 23 Uladzimir Makarau 55 54 1 rdavisau 51 18 33 alex-kondrashov 42 26 16 Silv3rcircl3 36 30 6 evertmulder 33 19 14 Filip Malachowicz 13 11 2 Suhas Chatekar 7 6 1 tintoy 4 2 2 Jonathan 2 1 1 neekgreen 2 1 1 Christopher Martin 2 1 1 Artem Borzilov

1.0.4 August 07 2015

Maintenance release for Akka.NET v1.0.3

Akka.IO This release introduces some major new features to Akka.NET, including Akka.IO - a new set of capabilities built directly into the Akka NuGet package that allow you to communicate with your actors directly via TCP and UDP sockets from external (non-actor) systems.

If you want to see a really cool example of Akka.IO in action, look at this sample that shows off how to use the Telnet commandline to interact directly with Akka.NET actors.

Akka.Persistence.MongoDb and Akka.Persistence.Sqlite Two new flavors of Akka.Persistence support are now available. You can install them via the commandline!

PM> Install-Package Akka.Persistence.MongoDb -pre

and

PM> Install-Package Akka.Persistence.Sqlite -pre

Fixes & Changes - Akka.NET Core

Akka.DI.StructureMap We now have support for the StructureMap dependency injection framework out of the box. You can install it here!

PM> Install-Package Akka.DI.StructureMap

1.0.3 June 12 2015

Bugfix release for Akka.NET v1.0.2.

This release addresses an issue with Akka.Persistence.SqlServer and Akka.Persistence.PostgreSql where both packages were missing a reference to Akka.Persistence.Sql.Common.

In Akka.NET v1.0.3 we've packaged Akka.Persistence.Sql.Common into its own NuGet package and referenced it in the affected packages.

1.0.2 June 2 2015

Bugfix release for Akka.NET v1.0.1.

Fixes & Changes - Akka.NET Core

Fixes & Changes - Akka.NET Dependency Injection

Fixes & Changes - Akka.Remote and Akka.Cluster

Fixes & Changes - Akka.Persistence

New Features:

Akka.TestKit.XUnit2 Akka.NET now has support for XUnit 2.0! You can install Akka.TestKit.XUnit2 via the NuGet commandline:

PM> Install-Package Akka.TestKit.XUnit2

Akka.Persistence.PostgreSql and Akka.Persistence.Cassandra Akka.Persistence now has two additional concrete implementations for PostgreSQL and Cassandra! You can install either of the packages using the following commandline:

Akka.Persistence.PostgreSql Configuration Docs

PM> Install-Package Akka.Persistence.PostgreSql

Akka.Persistence.Cassandra Configuration Docs

PM> Install-Package Akka.Persistence.Cassandra

Akka.DI.StructureMap Akka.NET's dependency injection system now supports StructureMap! You can install Akka.DI.StructureMap via the NuGet commandline:

PM> Install-Package Akka.DI.StructureMap

1.0.1 Apr 28 2015

Bugfix release for Akka.NET v1.0.

Fixes:

New Features:

Akka.TestKit.NUnit Akka.NET now has support for NUnit inside its TestKit. You can install Akka.TestKit.NUnit via the NuGet commandline:

PM> Install-Package Akka.TestKit.NUnit

Akka.Persistence.SqlServer The first full implementation of Akka.Persistence is now available for SQL Server.

Read the full instructions for working with Akka.Persistence.SQLServer here.

1.0.0 Apr 09 2015

Akka.NET is officially no longer in beta status. The APIs introduced in Akka.NET v1.0 will enjoy long-term support from the Akka.NET development team and all of its professional support partners.

Many breaking changes were introduced between v0.8 and v1.0 in order to provide better future extensibility and flexibility for Akka.NET, and we will outline the major changes in detail in these release notes.

However, if you want full API documentation we recommend going to the following:

Updated Packages with 1.0 Stable Release

All of the following NuGet packages have been upgraded to 1.0 for stable release:

  • Akka.NET Core
  • Akka.FSharp
  • Akka.Remote
  • Akka.TestKit
  • Akka.DI (dependency injection)
  • Akka.Loggers (logging)

The following packages (and modules dependent on them) are still in pre-release status:

  • Akka.Cluster
  • Akka.Persistence

Introducing Full Mono Support for Akka.NET

One of the biggest changes in Akka.NET v1.0 is the introduction of full Mono support across all modules; we even have Raspberry PI machines talking to laptops over Akka.Remote!

We've tested everything using Mono v3.12.1 across OS X and Ubuntu.

Please let us know how well Akka.NET + Mono runs on your environment!

API Changes in v1.0

All methods returning an ActorRef now return IActorRef This is the most significant breaking change introduced in AKka.NET v1.0. Rather than returning the ActorRef abstract base class from all of the ActorOf, Sender and other methods we now return an instance of the IActorRef interface instead.

This was done in order to guarantee greater future extensibility without additional breaking changes, so we decided to pay off that technical debt now that we're supporting these APIs long-term.

Here's the set of breaking changes you need to be aware of:

  • Renamed:
    • ActorRef --> IActorRef
    • ActorRef.Nobody --> ActorRefs.Nobody
    • ActorRef.NoSender --> ActorRefs.NoSender
  • ActorRef's operators == and != has been removed. This means all expressions like actorRef1 == actorRef2 must be replaced with Equals(actorRef1, actorRef2)
  • Tell(object message), i.e. the implicit sender overload, has been moved to an extension method, and requires using Akka.Actor; to be accessible.
  • Implicit cast from ActorRef to Routee has been replaced with Routee.FromActorRef(actorRef)

async / await Support

ReceiveActors now support Async/Await out of the box.

public class MyActor : ReceiveActor
{
       public MyActor()
       {
             Receive<SomeMessage>(async some => {
                    //we can now safely use await inside this receive handler
                    await SomeAsyncIO(some.Data);
                    Sender.Tell(new EverythingIsAllOK());                   
             });
       }
}

It is also possible to specify the behavior for the async handler, using AsyncBehavior.Suspend and AsyncBehavior.Reentrant as the first argument. When using Suspend the normal actor semantics will be preserved, the actor will not be able to process any new messages until the current async operation is completed. While using Reentrant will allow the actor to multiplex messages during the await period. This does not mean that messages are processed in parallel, we still stay true to "one message at a time", but each await continuation will be piped back to the actor as a message and continue under the actors concurrency constraint.

However, PipeTo pattern is still the preferred way to perform async operations inside an actor, as it is more explicit and clearly states what is going on.

Switchable Behaviors In order to make the switchable behavior APIs more understandable for both UntypedActor and ReceiveActor we've updated the methods to the following:

Become(newHandler); // become newHandler, without adding previous behavior to the stack (default)
BecomeStacked(newHandler); // become newHandler, without adding previous behavior to the stack (default)
UnbecomeStacked(); //revert to the previous behavior in the stack

The underlying behavior-switching implementation hasn't changed at all - only the names of the methods.

Scheduler APIs The Context.System.Scheduler API has been overhauled to be both more extensible and understandable going forward. All of the previous capabilities for the Scheduler are still available, only in different packaging than they were before.

Here are the new APIs:

Context.System.Scheduler
  .ScheduleTellOnce(TimeSpan delay, ICanTell receiver, object message, ActorRef sender);
  .ScheduleTellOnce(TimeSpan delay, ICanTell receiver, object message, ActorRef sender, ICancelable cancelable);
  .ScheduleTellRepeatedly(TimeSpan initialDelay, TimeSpan interval, ICanTell receiver, object message, ActorRef sender);
  .ScheduleTellRepeatedly(TimeSpan initialDelay, TimeSpan interval, ICanTell receiver, object message, ActorRef sender, ICancelable cancelable);

Context.System.Scheduler.Advanced
  .ScheduleOnce(TimeSpan delay, Action action);
  .ScheduleOnce(TimeSpan delay, Action action, ICancelable cancelable);
  .ScheduleRepeatedly(TimeSpan initialDelay, TimeSpan interval, Action action);
  .ScheduleRepeatedly(TimeSpan initialDelay, TimeSpan interval, Action action, ICancelable cancelable);

There's also a set of extension methods for specifying delays and intervals in milliseconds as well as methods for all four variants (ScheduleTellOnceCancelable, ScheduleTellRepeatedlyCancelable, ScheduleOnceCancelable, ScheduleRepeatedlyCancelable) that creates a cancelable, schedules, and returns the cancelable.

Akka.NET Config now loaded automatically from App.config and Web.config In previous versions Akka.NET users had to do the following to load Akka.NET HOCON configuration sections from App.config or Web.config:

var section = (AkkaConfigurationSection)ConfigurationManager.GetSection("akka");
var config = section.AkkaConfig;
var actorSystem = ActorSystem.Create("MySystem", config);

As of Akka.NET v1.0 this is now done for you automatically:

var actorSystem = ActorSystem.Create("MySystem"); //automatically loads App/Web.config, if any

Dispatchers Akka.NET v1.0 introduces the ForkJoinDispatcher as well as general purpose dispatcher re-use.

Using ForkJoinDispatcher ForkJoinDispatcher is special - it uses Helios.Concurrency.DedicatedThreadPool to create a dedicated set of threads for the exclusive use of the actors configured to use a particular ForkJoinDispatcher instance. All of the remoting actors depend on the default-remote-dispatcher for instance.

Here's how you can create your own ForkJoinDispatcher instances via Config:

myapp{
  my-forkjoin-dispatcher{
    type = ForkJoinDispatcher
    throughput = 100
    dedicated-thread-pool{ #settings for Helios.DedicatedThreadPool
      thread-count = 3 #number of threads
      #deadlock-timeout = 3s #optional timeout for deadlock detection
      threadtype = background #values can be "background" or "foreground"
    }
  }
}
}

You can then use this specific ForkJoinDispatcher instance by configuring specific actors to use it, whether it's via config or the fluent interface on Props:

Config

akka.actor.deploy{
     /myActor1{
       dispatcher = myapp.my-forkjoin-dispatcher
     }
}

Props

var actor = Sys.ActorOf(Props.Create<Foo>().WithDispatcher("myapp.my-forkjoin-dispatcher"));

FluentConfiguration [REMOVED] FluentConfig has been removed as we've decided to standardize on HOCON configuration, but if you still want to use the old FluentConfig bits you can find them here: https://github.com/rogeralsing/Akka.FluentConfig

F# API The F# API has changed to reflect the other C# interface changes, as well as unique additions specific to F#.

In addition to updating the F# API, we've also fixed a long-standing bug with being able to serialize discriminated unions over the wire. This has been resolved.

Interface Renames In order to comply with .NET naming conventions and standards, all of the following interfaces have been renamed with the I{InterfaceName} prefix.

The following interfaces have all been renamed to include the I prefix:

  • Akka.Actor.ActorRefProvider, Akka (Public)
  • Akka.Actor.ActorRefScope, Akka (Public)
  • Akka.Actor.AutoReceivedMessage, Akka (Public)
  • Akka.Actor.Cell, Akka (Public)
  • Akka.Actor.Inboxable, Akka (Public)
  • Akka.Actor.IndirectActorProducer, Akka (Public)
  • Akka.Actor.Internal.ChildrenContainer, Akka (Public)
  • Akka.Actor.Internal.ChildStats, Akka (Public)
  • Akka.Actor.Internal.InternalSupportsTestFSMRef2, Akka` (Public)
  • Akka.Actor.Internal.SuspendReason+WaitingForChildren, Akka
  • Akka.Actor.Internals.InitializableActor, Akka (Public)
  • Akka.Actor.LocalRef, Akka
  • Akka.Actor.LoggingFSM, Akka (Public)
  • Akka.Actor.NoSerializationVerificationNeeded, Akka (Public)
  • Akka.Actor.PossiblyHarmful, Akka (Public)
  • Akka.Actor.RepointableRef, Akka (Public)
  • Akka.Actor.WithBoundedStash, Akka (Public)
  • Akka.Actor.WithUnboundedStash, Akka (Public)
  • Akka.Dispatch.BlockingMessageQueueSemantics, Akka (Public)
  • Akka.Dispatch.BoundedDequeBasedMessageQueueSemantics, Akka (Public)
  • Akka.Dispatch.BoundedMessageQueueSemantics, Akka (Public)
  • Akka.Dispatch.DequeBasedMailbox, Akka (Public)
  • Akka.Dispatch.DequeBasedMessageQueueSemantics, Akka (Public)
  • Akka.Dispatch.MessageQueues.MessageQueue, Akka (Public)
  • Akka.Dispatch.MultipleConsumerSemantics, Akka (Public)
  • Akka.Dispatch.RequiresMessageQueue1, Akka` (Public)
  • Akka.Dispatch.Semantics, Akka (Public)
  • Akka.Dispatch.SysMsg.SystemMessage, Akka (Public)
  • Akka.Dispatch.UnboundedDequeBasedMessageQueueSemantics, Akka (Public)
  • Akka.Dispatch.UnboundedMessageQueueSemantics, Akka (Public)
  • Akka.Event.LoggingAdapter, Akka (Public)
  • Akka.FluentConfigInternals, Akka (Public)
  • Akka.Remote.InboundMessageDispatcher, Akka.Remote
  • Akka.Remote.RemoteRef, Akka.Remote
  • Akka.Routing.ConsistentHashable, Akka (Public)

ConsistentHashRouter and IConsistentHashable Akka.NET v1.0 introduces the idea of virtual nodes to the ConsistentHashRouter, which are designed to provide more even distributions of hash ranges across a relatively small number of routees. You can take advantage of virtual nodes via configuration:

akka.actor.deployment {
	/router1 {
		router = consistent-hashing-pool
		nr-of-instances = 3
		virtual-nodes-factor = 17
	}
}

Or via code:

var router4 = Sys.ActorOf(Props.Empty.WithRouter(
	new ConsistentHashingGroup(new[]{c},hashMapping: hashMapping)
	.WithVirtualNodesFactor(5)), 
	"router4");

ConsistentHashMapping Delegate There are three ways to instruct a router to hash a message:

  1. Wrap the message in a ConsistentHashableEnvelope;
  2. Implement the IConsistentHashable interface on your message types; or
  3. Or, write a ConsistentHashMapper delegate and pass it to a ConsistentHashingGroup or a ConsistentHashingPool programmatically at create time.

Here's an example, taken from the ConsistentHashSpecs:

ConsistentHashMapping hashMapping = msg =>
{
    if (msg is Msg2)
    {
        var m2 = msg as Msg2;
        return m2.Key;
    }

    return null;
};
var router2 =
    Sys.ActorOf(new ConsistentHashingPool(1, null, null, null, hashMapping: hashMapping)
    .Props(Props.Create<Echo>()), "router2");

Alternatively, you don't have to pass the ConsistentHashMapping into the constructor - you can use the WithHashMapping fluent interface built on top of both ConsistentHashingGroup and ConsistentHashingPool:

var router2 =
    Sys.ActorOf(new ConsistentHashingPool(1).WithHashMapping(hashMapping)
    .Props(Props.Create<Echo>()), "router2");

ConsistentHashable renamed to IConsistentHashable Any objects you may have decorated with the ConsistentHashable interface to work with ConsistentHashRouter instances will need to implement IConsistentHashable going forward, as all interfaces have been renamed with the I- prefix per .NET naming conventions.

Akka.DI.Unity NuGet Package Akka.NET now ships with dependency injection support for Unity.

You can install our Unity package via the following command in the NuGet package manager console:

PM> Install-Package Akka.DI.Unity

0.8.0 Feb 11 2015

Dependency Injection support for Ninject, Castle Windsor, and AutoFac. Thanks to some amazing effort from individual contributor (@jcwrequests), Akka.NET now has direct dependency injection support for Ninject, Castle Windsor, and AutoFac.

Here's an example using Ninject, for instance:

// Create and build your container 
var container = new Ninject.StandardKernel(); 
container.Bind().To(typeof(TypedWorker)); 
container.Bind().To(typeof(WorkerService));

// Create the ActorSystem and Dependency Resolver 
var system = ActorSystem.Create("MySystem"); 
var propsResolver = new NinjectDependencyResolver(container,system);

//Create some actors who need Ninject
var worker1 = system.ActorOf(propsResolver.Create<TypedWorker>(), "Worker1");
var worker2 = system.ActorOf(propsResolver.Create<TypedWorker>(), "Worker2");

//send them messages
worker1.Tell("hi!");

You can install these DI plugins for Akka.NET via NuGet - here's how:

  • Ninject - install-package Akka.DI.Ninject
  • Castle Windsor - install-package Akka.DI.CastleWindsor
  • AutoFac - install-package Akka.DI.AutoFac

Read the full Dependency Injection with Akka.NET documentation here.

Persistent Actors with Akka.Persistence (Alpha). Core contributor @Horusiath ported the majority of Akka's Akka.Persistence and Akka.Persistence.TestKit modules.

Even in the core Akka project these modules are considered to be "experimental," but the goal is to provide actors with a way of automatically saving and recovering their internal state to a configurable durable store - such as a database or filesystem.

Akka.Persistence also introduces the notion of reliable delivery of messages, achieved through the GuaranteedDeliveryActor.

Akka.Persistence also ships with an FSharp API out of the box, so while this package is in beta you can start playing with it either F# or C# from day one.

If you want to play with Akka.Persistence, please install any one of the following packages:

  • Akka.Persistence - install-package Akka.Persistence -pre
  • Akka.Persistence.FSharp - install-package Akka.Persistence.FSharp -pre
  • Akka.Persistence.TestKit - install-package Akka.Persistence.TestKit -pre

Read the full Persistent Actors with Akka.NET documentation here.

Remote Deployment of Routers and Routees. You can now remotely deploy routers and routees via configuration, like so:

Deploying routees remotely via Config:

actor.deployment {
    /blub {
      router = round-robin-pool
      nr-of-instances = 2
      target.nodes = [""akka.tcp://${sysName}@localhost:${port}""]
    }
}

var router = masterActorSystem.ActorOf(new RoundRobinPool(2).Props(Props.Create<Echo>()), "blub");

When deploying a router via configuration, just specify the target.nodes property with a list of Address instances for each node you want to deploy your routees.

NOTE: Remote deployment of routees only works for Pool routers.

Deploying routers remotely via Config:

actor.deployment {
    /blub {
      router = round-robin-pool
      nr-of-instances = 2
      remote = ""akka.tcp://${sysName}@localhost:${port}""
    }
}

var router = masterActorSystem.ActorOf(Props.Create<Echo>().WithRouter(FromConfig.Instance), "blub");

Works just like remote deployment of actors.

If you want to deploy a router remotely via explicit configuration, you can do it in code like this via the RemoteScope and RemoteRouterConfig:

Deploying routees remotely via explicit configuration:

var intendedRemoteAddress = Address.Parse("akka.tcp://${sysName}@localhost:${port}"
.Replace("${sysName}", sysName)
.Replace("${port}", port.ToString()));

 var router = myActorSystem.ActorOf(new RoundRobinPool(2).Props(Props.Create<Echo>())
.WithDeploy(new Deploy(
	new RemoteScope(intendedRemoteAddress.Copy()))), "myRemoteRouter");

Deploying routers remotely via explicit configuration:

var intendedRemoteAddress = Address.Parse("akka.tcp://${sysName}@localhost:${port}"
.Replace("${sysName}", sysName)
.Replace("${port}", port.ToString()));

 var router = myActorSystem.ActorOf(
	new RemoteRouterConfig(
	new RoundRobinPool(2), new[] { new Address("akka.tcp", sysName, "localhost", port) })
    .Props(Props.Create<Echo>()), "blub2");

Improved Serialization and Remote Deployment Support. All internals related to serialization and remote deployment have undergone vast improvements in order to support the other work that went into this release.

Pluggable Actor Creation Pipeline. We reworked the plumbing that's used to provide automatic Stash support and exposed it as a pluggable actor creation pipeline for local actors.

This release adds the ActorProducerPipeline, which is accessible from ExtendedActorSystem (to be able to configure by plugins) and allows you to inject custom hooks satisfying following interface:

interface IActorProducerPlugin {
    bool CanBeAppliedTo(ActorBase actor);
    void AfterActorCreated(ActorBase actor, IActorContext context);
    void BeforeActorTerminated(ActorBase actor, IActorContext context);
}
  • CanBeAppliedTo determines if plugin can be applied to specific actor instance.
  • AfterActorCreated is applied to actor after it has been instantiated by an ActorCell and before InitializableActor.Init method will (optionally) be invoked.
  • BeforeActorTerminated is applied before actor terminates and before IDisposable.Dispose method will be invoked (for disposable actors) - auto handling disposable actors is second feature of this commit.

For common use it's better to create custom classes inheriting from ActorProducerPluginBase and ActorProducerPluginBase<TActor> classes.

Pipeline itself provides following interface:

class ActorProducerPipeline : IEnumerable<IActorProducerPlugin> {
    int Count { get; } // current plugins count - 1 by default (ActorStashPlugin)
    bool Register(IActorProducerPlugin plugin)
    bool Unregister(IActorProducerPlugin plugin)
    bool IsRegistered(IActorProducerPlugin plugin)
    bool Insert(int index, IActorProducerPlugin plugin)
}
  • Register - registers a plugin if no other plugin of the same type has been registered already (plugins with generic types are counted separately). Returns true if plugin has been registered.
  • Insert - same as register, but plugin will be placed in specific place inside the pipeline - useful if any plugins precedence is required.
  • Unregister - unregisters specified plugin if it has been found. Returns true if plugin was found and unregistered.
  • IsRegistered - checks if plugin has been already registered.

By default pipeline is filled with one already used plugin - ActorStashPlugin, which replaces stash initialization/unstashing mechanism used up to this moment.

MultiNodeTestRunner and Akka.Remote.TestKit. The MultiNodeTestRunner and the Multi Node TestKit (Akka.Remote.TestKit) underwent some drastic changes in this update. They're still not quite ready for public use yet, but if you want to see what the experience is like you can clone the Akka.NET Github repository and run the following command:

C:\akkadotnet> .\build.cmd MultiNodeTests

This will automatically launch all MultiNodeSpec instances found inside Akka.Cluster.Tests. We'll need to make this more flexible to be able to run other assemblies that require multinode tests in the future.

These tests are not enabled by default in normal build runs, but they will at some point in the future.

Here's a sample of the output from the console, to give you a sense of what the reporting looks like:

image

The MultiNodeTestRunner uses XUnit internally and will dynamically deploy as many processes are needed to satisfy any individual test. Has been tested with up to 6 processes.

0.7.1 Dec 13 2014

Brand New F# API. The entire F# API has been updated to give it a more native F# feel while still holding true to the Erlang / Scala conventions used in actor systems. Read more about the F# API changes.

Multi-Node TestKit (Alpha). Not available yet as a NuGet package, but the first pass at the Akka.Remote.TestKit is now available from source, which allow you to test your actor systems running on multiple machines or processes.

A multi-node test looks like this

public class InitialHeartbeatMultiNode1 : InitialHeartbeatSpec
{
}

public class InitialHeartbeatMultiNode2 : InitialHeartbeatSpec
{
}

public class InitialHeartbeatMultiNode3 : InitialHeartbeatSpec
{
}

public abstract class InitialHeartbeatSpec : MultiNodeClusterSpec

The MultiNodeTestRunner looks at this, works out that it needs to create 3 processes to run 3 nodes for the test. It executes NodeTestRunner in each process to do this passing parameters on the command line. Read more about the multi-node testkit here.

Breaking Change to the internal api: The Next property on IAtomicCounter<T> has been changed into the function Next() This was done as it had side effects, i.e. the value was increased when the getter was called. This makes it very hard to debug as the debugger kept calling the property and causing the value to be increased.

Akka.Serilog SerilogLogMessageFormatter has been moved to the namespace Akka.Logger.Serilog (it used to be in Akka.Serilog.Event.Serilog). Update your using statements from using Akka.Serilog.Event.Serilog; to using Akka.Logger.Serilog;.

Breaking Change to the internal api: Changed signatures in the abstract class SupervisorStrategy. The following methods has new signatures: HandleFailure, ProcessFailure. If you've inherited from SupervisorStrategy, OneForOneStrategy or AllForOneStrategy and overridden the aforementioned methods you need to update their signatures.

TestProbe can be implicitly casted to ActorRef. New feature. Tests requiring the ActorRef of a TestProbe can now be simplified:

var probe = CreateTestProbe();
var sut = ActorOf<GreeterActor>();
sut.Tell("Akka", probe); // previously probe.Ref was required
probe.ExpectMsg("Hi Akka!");

Bugfix for ConsistentHashableEvenlope. When using ConsistentHashableEvenlope in conjunction with ConsistentHashRouters, ConsistentHashableEvenlope now correctly extracts its inner message instead of sending the entire ConsistentHashableEvenlope directly to the intended routee.

Akka.Cluster group routers now work as expected. New update of Akka.Cluster - group routers now work as expected on cluster deployments. Still working on pool routers. Read more about Akka.Cluster routers here.

0.7.0 Oct 16 2014

Major new changes and additions in this release, including some breaking changes...

Akka.Cluster Support (pre-release) - Akka.Cluster is now available on NuGet as a pre-release package (has a -pre suffix) and is available for testing. After installing the the Akka.Cluster module you can add take advantage of clustering via configuration, like so:

akka {
    actor {
      provider = "Akka.Cluster.ClusterActorRefProvider, Akka.Cluster"
    }

    remote {
      log-remote-lifecycle-events = DEBUG
      helios.tcp {
    hostname = "127.0.0.1"
    port = 0
      }
    }

    cluster {
      seed-nodes = [
    "akka.tcp://[email protected]:2551",
    "akka.tcp://[email protected]:2552"]

      auto-down-unreachable-after = 10s
    }
  }

And then use cluster-enabled routing on individual, named routers:

/myAppRouter {
 router = consistent-hashing-pool
  nr-of-instances = 100
  cluster {
    enabled = on
    max-nr-of-instances-per-node = 3
    allow-local-routees = off
    use-role = backend
  }
}

For more information on how clustering works, please see akkadotnet#400

Breaking Changes: Improved Stashing - The old WithUnboundedStash and WithBoundedStash interfaces have been slightly changed and the CurrentStash property has been renamed to Stash. Any old stashing code can be replaced with the following in order to continue working:

public IStash CurrentStash { get { return Stash; } set { Stash=value; } }

The Stash field is now automatically populated with an appropriate stash during the actor creation process and there is no need to set this field at all yourself.

Breaking Changes: Renamed Logger Namespaces - The namespaces, DLL names, and NuGet packages for all logger add-ons have been changed to Akka.Loggers.Xyz. Please install the latest NuGet package (and uninstall the old ones) and update your Akka HOCON configurations accordingly.

Serilog Support - Akka.NET now has an official Serilog logger that you can install via the Akka.Logger.Serilog package. You can register the serilog logger via your HOCON configuration like this:

 akka.loggers=["Akka.Logger.Serilog.SerilogLogger, Akka.Logger.Serilog"]

New Feature: Priority Mailbox - The PriorityMailbox allows you to define the priority of messages handled by your actors, and this is done by creating your own subclass of either the UnboundedPriorityMailbox or BoundedPriorityMailbox class and implementing the PriorityGenerator method like so:

public class ReplayMailbox : UnboundedPriorityMailbox
{
    protected override int PriorityGenerator(object message)
    {
        if (message is HttpResponseMessage) return 1;
        if (!(message is LoggedHttpRequest)) return 2;
        return 3;
    }
}

The smaller the return value from the PriorityGenerator, the higher the priority of the message. You can then configure your actors to use this mailbox via configuration, using a fully-qualified name:

replay-mailbox {
 mailbox-type: "TrafficSimulator.PlaybackApp.Actors.ReplayMailbox,TrafficSimulator.PlaybackApp"
}

And from this point onward, any actor can be configured to use this mailbox via Props:

Context.ActorOf(Props.Create<ReplayActor>()
                    .WithRouter(new RoundRobinPool(3))
                    .WithMailbox("replay-mailbox"));

New Feature: Test Your Akka.NET Apps Using Akka.TestKit - We've refactored the testing framework used for testing Akka.NET's internals into a test-framework-agnostic NuGet package you can use for unit and integration testing your own Akka.NET apps. Right now we're scarce on documentation so you'll want to take a look at the tests inside the Akka.NET source for reference.

Right now we have Akka.TestKit adapters for both MSTest and XUnit, which you can install to your own project via the following:

MSTest:

install-package Akka.TestKit.VsTest

XUnit:

install-package Akka.TestKit.Xunit

New Feature: Logging to Standard Out is now done in color - This new feature can be disabled by setting StandardOutLogger.UseColors = false;. Colors can be customized: StandardOutLogger.DebugColor = ConsoleColor.Green;. If you need to print to stdout directly use Akka.Util.StandardOutWriter.Write() instead of Console.WriteLine, otherwise your messages might get printed in the wrong color.

0.6.4 Sep 9 2014

  • Introduced TailChoppingRouter
  • All ActorSystem extensions now take an ExtendedActorSystem as a dependency - all third party actor system extensions will need to update accordingly.
  • Fixed numerous bugs with remote deployment of actors.
  • Fixed a live-lock issue for high-traffic connections on Akka.Remote and introduced softer heartbeat failure deadlines.
  • Changed the configuration chaining process.
  • Removed obsolete attributes from PatternMatch and UntypedActor.
  • Laying groundwork for initial Mono support.

0.6.3 Aug 13 2014

  • Made it so HOCON config sections chain properly
  • Optimized actor memory footprint
  • Fixed a Helios bug that caused Akka.NET to drop messages larger than 32kb

0.6.2 Aug 05 2014

  • Upgraded Helios dependency
  • Bug fixes
  • Improved F# API
  • Resizeable Router support
  • Inbox support - an actor-like object that can be subscribed to by external objects
  • Web.config and App.config support for Akka HOCON configuration

0.6.1 Jul 09 2014

  • Upgraded Helios dependency
  • Added ConsistentHash router support
  • Numerous bug fixes
  • Added ReceiveBuilder support

0.2.1-beta Mars 22 2014

  • Nuget package