Orleans - Distributed Actor Model


Orleans is a framework that provides a straight-forward approach to building distributed high-scale computing applications, without the need to learn and apply complex concurrency or other scaling patterns. It was created by Microsoft Research and designed for use in the cloud. Orleans has been used extensively running in Microsoft Azure by several Microsoft product groups, most notably by 343 Industries as a platform for all of Halo 4 and Halo 5 cloud services, as well as by a number of other projects and companies.

Installation

Installation is performed via NuGet. There are several packages, one for each different project type (interfaces, grains, silo, and client).

In the grain interfaces project:

PM> Install-Package Microsoft.Orleans.Templates.Interfaces

In the grain implementations project:

PM> Install-Package Microsoft.Orleans.Templates.Grains

In the server (silo) project:

PM> Install-Package Microsoft.Orleans.Server

In the client project:

PM> Install-Package Microsoft.Orleans.Client

Official Builds

The stable production-quality release is located here.

The latest clean development branch build from CI is located: here

Building From Source

Clone the sources and run the Build.cmd script to build the binaries locally.

Then reference the required assemblies from Binaries\Release\* or the NuGet packages from Binaries\NuGet.Packages\*.

Documentation

Documentation is located here

Example

Create an interface for your grain:

public interface IHello : Orleans.IGrainWithIntegerKey
{
  Task<string> SayHello(string greeting);
}

Provide an implementation of that interface:

public class HelloGrain : Orleans.Grain, IHello
{
  Task<string> SayHello(string greeting)
  {
    return Task.FromResult($"You said: '{greeting}', I say: Hello!");
  }
}

Call the grain from your Web service (or anywhere else):

// Get a reference to the IHello grain with id '0'.
var friend = GrainClient.GrainFactory.GetGrain<IHello>(0);

// Send a greeting to the grain an await the response.
Console.WriteLine(await friend.SayHello("Good morning, my friend!"));

Contributing To This Project

• List of Ideas for Contributions

• Contributing Guide

• CLA - Contribution License Agreement

• The coding standards / style guide used for Orleans code is the .NET Framework Design Guidelines

• Orleans Community - Repository of community add-ons to Orleans Various community projects, including Orleans Monitoring, Design Patterns, Storage Provider, etc.

You are also encouraged to start a discussion by filing an issue.

License

This project is licensed under the MIT license.