C# HTML PowerShell PLpgSQL Batchfile Visual Basic
Permalink
Failed to load latest commit information.
Build Clean up Orleans.2017.sln (#3068) May 30, 2017
Samples Update dependency to Orleans 1.4.2 Jun 10, 2017
misc Added files via upload Apr 6, 2016
src ServiceFabric: register ISiloStatusOracle implementation (#3160) Jun 25, 2017
test make EHStatisticMonitorTests more predictable (#3140) Jun 23, 2017
vNext Expose available versions information in placement context (#3136) Jun 19, 2017
.gitattributes Add .gitattributes file Jan 27, 2015
.gitignore Clean up Orleans.2017.sln (#3068) May 30, 2017
Build.2017.cmd Updates to vNext tree in preparation for trees merge (#3091) Jun 13, 2017
Build.cmd Build process cleanup for newer tooling (#2798) Mar 1, 2017
Directory.Build.props Updates to vNext tree in preparation for trees merge (#3091) Jun 13, 2017
DotnetCLIVersion.txt Updates to vNext tree in preparation for trees merge (#3091) Jun 13, 2017
LICENSE Update LICENSE Apr 22, 2015
Orleans.2017.sln Clean up Orleans.2017.sln (#3068) May 30, 2017
Parallel-Tests.2017.ps1 Clean up Orleans.2017.sln (#3068) May 30, 2017
README.md Fix README badges (#3008) May 10, 2017
Test.2017.cmd Clean up Orleans.2017.sln (#3068) May 30, 2017
Test.cmd Build process cleanup for newer tooling (#2798) Mar 1, 2017
TestAll.2017.cmd Clean up Orleans.2017.sln (#3068) May 30, 2017
TestAll.cmd Build process cleanup for newer tooling (#2798) Mar 1, 2017
changelog.md Expose available versions information in placement context (#3136) Jun 19, 2017
init-tools.cmd Clean up Orleans.2017.sln (#3068) May 30, 2017
netci.groovy Set OrleansDataConnectionString env variable to empty Mar 29, 2017

README.md

Orleans logo

Build status NuGet Gitter Help Wanted Issues

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 implementing the Virtual Actor Model 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.OrleansCodeGenerator.Build

In the grain implementations project:

PM> Install-Package Microsoft.Orleans.OrleansCodeGenerator.Build

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 from the GitHub repo

Run run the Build.cmd script to build the binaries locally, then reference the required NuGet packages from Binaries\NuGet.Packages\*.

Documentation

Documentation is located here

Code Examples

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 and await the response.
Console.WriteLine(await friend.SayHello("Good morning, my friend!"));

Blog

Orleans Blog is a place to share our thoughts, plans, learnings, tips and tricks, and ideas, crazy and otherwise, which don’t easily fit the documentation format. We would also like to see here posts from the community members, sharing their experiences, ideas, and wisdom. So, welcome to Orleans Blog, both as a reader and as a blogger!

Community

License

This project is licensed under the MIT license.

Quick Links

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.