Awesome

Orleankka is a functional extension for Microsoft Orleans framework. It provides a message-based API similar to Akka/ProtoActor, carefully layered on top of the Orleans (that's what in a name). Orleankka is an excellent choice for use-cases which can benefit from composable, uniform communication interface, such as CQRS, event-sourcing, FSM, etc.

References: intro, features, slides and discussion.

Features

• Message-based API with zero performance overhead
• Switchable actor behaviors with built-in hierarchical FSM (behaviors)
• Additional api to simplify programming long-running background tasks (jobs)
• Poweful actor/proxy middlewares (interceptors)
• Convenient unit testing kit (stubs, mocks, expectations)

How to install

To install client Orleankka library via NuGet, run this command in NuGet package manager console:

PM> Install-Package Orleankka.Client

For server-side library:

PM> Install-Package Orleankka.Runtime

Check out "Getting started" guide

Build sources

You will need VS2019 and .NET Core 3.x installed in order to build and open the solution. Clone repository and run the following in CLI from solution's root folder:

PM> Nake.bat

This will restore dependencies and build everything in debug mode. Run Nake.bat with -T switch to see available commands.

On MacOS\Linux distributions use below script to build, package or run tests:

$> ./nake.sh

Packages

Examples

• Hello, world! [demo]
• "WebScan" [demo]
• TestKit [demo]
• Event Sourcing
  • Idiomatic (CQRS) [see]
  • Persistence: GetEventStore [see]
  • Persistence: Streamstone [see]
• Reentrant messages [rw-x]
• Client-side observers [chat]
• Streams [chat]
• Switchable behaviors
  • Basics [see]
  • Durable FSM with supervision[see]

Documentation

At present, documentation is undergoing a major overhaul. Please, check the unit tests and examples above to get up-to-date information on API usage.

Community

• Join Gitter chat
• Follow the @Orleankka Twitter account for announcements

License

Apache 2 License