Home / .NET / Distributed Computing

Functional API for Microsoft Orleans http://orleanscontrib.github.io/Orleankka/

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-cas
Information
Category: .NET / Distributed Computing
Watchers: 47
Star: 476
Fork: 77
Last update: Sep 18, 2023
Resource links
https://github.com/OrleansContrib/Orleankka

Orleankka Logo

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

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.

Packages

Package Description
Orleankka Core and client lib
Orleankka.Runtime Server-side runtime lib
Orleankka.TestKit Unit testing kit

Examples

Documentation

Documentation can be found here.

Community

License

Apache 2 License

3 Open More issues
Closed

Silo/Actor-level interceptors

Currentlly, to achieve something similar, people use inheritance, which is a wrong way to tackle the problem. Orthogonal concerns should not be added via inheritance.

Interceptors should have access to Actor instance and its services. For example interceptor can auto deactivate actor on concurrent writes (split-brain).

This is also requried to be on par with Orleans functionality.

opened Nov 25, 2016 by yevhen 15
Closed

use tasks from fsharpx

opened Jan 21, 2017 by aprooks 13
Closed

Resuming client stream subscription

There is no option in Orleankka to Resume client stream subscription. Our client is unstable and is subscribing over and over again until it blows up pubsub store. More info.

bug 
opened Dec 9, 2016 by mhertis 12
Closed

Ported Chat Demo to C#

Ported the F# Chat Client/Server demo to C#.

opened May 23, 2015 by ElanHasson 12
Closed

Exceptions in loading assemblies to ConfigureApplicationParts

opened Oct 23, 2018 by oleksandrmelnychenko 10
Closed

Can Orleankka integrate with this architecture?

First of all, thank you for this great project!! I learned a lot of things.

I try to integrate cqrs & eventsourcing into my architecture and I try to find out if orleankka could match.

The need would be that Orleankka is the "message transmitter" (as shown below) that depends on my domain but not the other way around.

Q1 : The videos pointed in the readme of the project make me think that it is possible with Orleans so it should be the same with Orleankaa?

Q2 : I have look at the issue "help wanted" for an example of Http-endpoint with WebApi (C#). Do you agree that this WebApi should expose "public commands" and perform different tasks before translating them into "domain commands"? (as shown below)

opened Mar 20, 2018 by JbmOnGitHub 10
Open

StreamRef and ImplicitStreamSubscription issues

In Orleankka 7.0.0 the legacy Orleankka.Legacy.Runtime.Streams (implicit stream subscription) code was removed and there is no alternative to this package

We heavily relied StreamSubscriptionAttribute because it offered regex implicit stream subscriptions, filtering and actor id selection. None of which is currently supported by orleans

In the upgrade attempt we wanted to use the ImplicitStreamSubscriptionAttribute / RegexImplicitStreamSubscriptionAttribute as the upgrade path but this doesn't work with the current StreamRef implementation. The current StreamRef implementation always uses null as the streamNamespace and the StreamPath.Id as the StreamId. Orleans implicit stream subscription implementation only supports not null namespaces: https://github.com/dotnet/orleans/blob/e498ee763fd09198a0af9c95899a4f1ef019e55e/src/Orleans.Streaming/PubSub/ImplicitStreamSubscriberTable.cs#L201C1-L204C10 and has no code that supports filtering by StreamId, currently only filtering by streamNamespace is implemented: https://github.com/dotnet/orleans/blob/e498ee763fd09198a0af9c95899a4f1ef019e55e/src/Orleans.Streaming/Predicates/StreamSubscriptionAttributes.cs#L14C1-L19C60

What is the correct upgrade path here? Do you have any ideas how we could achieve what was previously supported by the stream legacy code? Would it be possible to bring back to life the legacy code if there is no alternative?

opened Sep 18, 2023 by Jubast 0
Open

ActorPath changes between ActorRef and ActorGrain

When upgrading from Orleankka 3.x to 7.0.0 i've noticed that ActorPath.Id property changes between the client side and grain side

Example code:

using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Hosting;
using Orleankka;
using Orleankka.Cluster;
using Orleankka.Meta;

var host = await new HostBuilder()    
    .UseOrleans(orleans => orleans.UseLocalhostClustering())
    .UseOrleankka()
    .StartAsync();

var system = host.Services.GetService<IActorSystem>();
var @ref = system.ActorOf<ITestActor>("myId");

Console.WriteLine($"ActorPath on client: {@ref.Path}");

await @ref.Tell(new TestCommand());
await host.StopAsync();

public interface ITestActor : IActorGrain, IGrainWithStringKey { }

public class TestActor : DispatchActorGrain, ITestActor
{
    public void Handle(TestCommand _) => Console.WriteLine($"ActorPath on grain: {Path}");
}

[GenerateSerializer]
public class TestCommand : Command { }

Output:

ActorPath on client: ITestActor:myId
ActorPath on grain: ITestActor:testactor/myId

This happens because of the current ActorGrain initialization logic where the whole GrainId(GrainType + Key) gets forwarded the actor id: https://github.com/OrleansContrib/Orleankka/blob/4a0172978cdb53740ce31bb592fca451bccb14a1/Source/Orleankka.Runtime/ActorActivator.cs#L12 I believe this is unintended, would you accept a change request so that only GrainId.Key gets forwarded as the id?

opened Sep 18, 2023 by Jubast 0
Open

[EXAMPLE] Http-endpoint with WebAPI (C#)

Showcase how to dealing with serialization, routing, media types, versioning, etc. See @damianh Cedar.CommandHandling for inspiration

help wanted example 
opened Jun 29, 2015 by yevhen 8

7.0.0(May 25, 2023)

Changes

  • Updated everything to run on Orleans 7.x
  • Migrated to native .NET hosting API
  • Added support for native serialization for ActorPath, StreamPath, ActorRef, StreamRef, ClientRef
  • All samples were migrated to use IInvokable instead of InvokeMethodRequest in MayInterleave static callbacks
  • DeactivationReason was added to Deactivate message
  • Separated lifecycle messages sent on grain and state activation/deactivation via Activate.State and Activate.External static messages

Breaking changes:

  • Removed support for IGrainActivator in favor of native grain activation services
  • Removed support for stream filtering since it's not supported by Orleans streaming api
  • Removed implicit stream subscriptions via StreamSubscriptionAttribute in favor of native ImplicitStreamSubscription and RegexStreamSubscritpion attributes
  • Roundtrip serialization checking in TestKit now accepts IServiceProvider and uses serializer registered in container instead of direct use of not available in 7.x Serializer class
  • CreateObservable() on IActorSystem is now synchronous and returns reference to IClientEndpoint instead of Task<IClientEndpoint>

Bug fixes

  • Fixed concurrency bug with key no found exception fired on timer removal when the one-off timer was fired before await

3.5(Jun 6, 2021)

Changes

  • Introduction of StreamRef middleware [see #173]. Kudos to @Jubast for PR!

3.4(Oct 28, 2020)

Changes

  • Introduction of additional Orleannka.Client package which contains client-related API (ClientActorSystem) [see #169]

3.3.2020(Sep 10, 2020)

Details will follow

3.0.0(Dec 21, 2019)

Changes

  • Updated to work with Orleans 3.x

2.7.0(Dec 21, 2019)

New features

  • Actor grain lifecycle message were made serializable and moved to Orleankka core, so now it's possible to activate/deactivate any actor externally. Extensions methods were created for ActorRef and you can simply do system.ActorOf<IMyActor>("foo").Activate(). Note: activation is idempotent.
  • Behaviors: Become message was extended with Become<TArg> so now you can pass additional arguments to behavior:
behavior.Become(Failed, ex);

Task<object> Failed(object message)
{
    switch (message)
    {
        case Become<Exception> x: 
            log.Error(x.Argument);
            break;
    }
}

Contents

    christiansparre Simple sample showing that Microsoft Orleans works on Azure Container Apps
    Microsoft Microsoft Drivers for PHP for SQL Server
    dotnet Orleans is a cross-platform framework for building distributed applications with .NET
    Maarten88 Exploring a new web architecture with React, Redux, Orleans and Dotnet Core
    Kritner This package's intention is to expose an abstract base class to allow Orleans to work with long running, CPU bound, synchronous work, without becoming overloaded.
    dmitriz Examples with Functional JavaScript, following Professor Frisby's course
    Microsoft Microsoft SEAL is an easy-to-use and powerful homomorphic encryption library.
    stdlib Functional Microservice Request Library
    Microsoft Microsoft REST API Guidelines
    Microsoft The Microsoft JDBC Driver for SQL Server is a Type 4 JDBC driver that provides database connectivity with SQL Server through the standard JDBC application program interfaces (APIs).
    johnpaulada An unofficial Microsoft Machine Learning Server Docker image.
    MicrosoftEdge Microsoft Edge
    merill Helper scripts and guidance to add a Pronoun field (She/Her, They/Them, He/Him) to your Microsoft 365 tenant and display it in the Microsoft 365 profile card shown in Outlook, SharePoint, Delve...
    microsoft-sponsorships Microsoft's Free and Open Source Software Fund (FOSS Fund)
    serradura RequestVia: A Functional HTTP Client That Wraps Net::HTTP
    lstrojny Primitives for functional programming in PHP
    wavebitscientific Functional programming for modern Fortran
    typelift Functional programming in Swift
    louthy C# functional language extensions - a base class library for functional programming
    diku-dk HTTP utility library for Standard ML
    rumlang Functional language, easily extensible and possible (Lua features with LISP dialect and functional) to be embarked on software Go!
    Share this repo

    Related Repos


    Distributed Computin
    1.7k
    Fusion is a .NET library that implements DREAM – Distributed REActive Memoization.
    servicetitan Fusion implements DREAM - Distributed Reactive Memoization. Add real-time features to your apps (incl. Blazor) without a need for SignalR, WebSockets, or even events! Get 10-1000x faster API responses with a transparent and nearly 100% consistent cache. Get all of this with almost no extra code! A DREAM? See our samples.
     
    Distributed Computin
    261
    IronPigeon is a decentralized communication protocol that provides high confidentiality an...
    AArnott IronPigeon is a decentralized communication protocol that provides high confidentiality and authenticity for the messages.
     
    Distributed Computin
    286
    Sample Application DDD, Reactive Microservices, CQRS Event Sourcing Powered by DERMAYON LI...
    NHadi POS - DDD, Reactive Microservices, CQRS Event Sourcing Powered by DERMAYON LIBRARY Sample Application DDD Reactive Microservices with CQRS &amp; Event Sourcing with DERMAYON LIBRARY. Architectures Features
     
    Distributed Computin
    1.6k
    Proto Actor - Ultra fast distributed actors for Go, C# and Java/Kotlin
    asynkron Proto.Actor Ultra-fast, distributed, cross-platform actors. Installing Using NuGet Package Manager Console: PM&gt; Install-Package Proto.Actor Source code This is the .NET repository for Proto Actor.
     
    Popular
    Distributed Computin
    5.9k
    Virtual File System for Git: Enable Git at Enterprise Scale
    Microsoft VFS for Git Windows Branch Unit Tests Functional Tests Large Repo Perf Large Repo Build master shipped
     
    Distributed Computin
    476
    Functional API for Microsoft Orleans http://orleanscontrib.github.io/Orleankka/
    OrleansContrib 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-cas
     
    Distributed Computin
    275
    A lightweight Peer to Peer Service Bus
    Abc-Arbitrage Zebus Zebus is a lightweight peer to peer service bus, built with CQRS principles in mind. It allows applications to communicate with each other in a fast and easy manner. Most of the complexity is hidden in the library and y