Microsoft.Orleans.Runtime 10.4.0

Microsoft Orleans Runtime

Introduction

Microsoft Orleans Runtime is the core server-side component of Orleans. It hosts and executes grains, manages grain lifecycles, and provides all the runtime services necessary for a functioning Orleans server (silo).

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Runtime

This package is automatically included when you reference the Orleans Server metapackage.

Grain construction

Generated grain registrations preserve public constructor metadata for activation in trimmed and NativeAOT applications. The default grain activator uses dependency injection to select a public constructor, honors ActivatorUtilitiesConstructorAttribute, and resolves dependencies from each activation's service scope. Manual grain configuration uses GrainTypeOptions.AddClass(typeof(MyGrain)); manual manifest configuration uses TypeManifestOptions.AddInterfaceImplementation(typeof(MyGrain)). Both preserve the same constructor metadata. Direct Classes collection access and construction of a GrainClassMap from an arbitrary dictionary require callers to preserve constructors separately and emit trimming warnings.

File grain storage

The runtime includes a file-based grain storage provider for local, single-silo development and testing. It stores one binary file per grain state record and uses persisted ETags for optimistic concurrency.

using Orleans.Persistence.FileStorage;

siloBuilder.AddFileGrainStorage(
    options: options => options.RootDirectory = Path.Combine(
        AppContext.BaseDirectory,
        "Orleans",
        "GrainState"));

Example - Configuring a Silo

using Microsoft.Extensions.Hosting;
using Orleans.Configuration;
using Orleans.Hosting;

var builder = Host.CreateApplicationBuilder(args)
    .UseOrleans(siloBuilder =>
    {
        siloBuilder
            .UseLocalhostClustering();
    });

await builder.Build().RunAsync();

Documentation

For more comprehensive documentation, please refer to:

• Microsoft Orleans Documentation
• Server configuration
• Silo lifecycle
• Clustering

Feedback & Contributing

• If you have any issues or would like to provide feedback, please open an issue on GitHub
• Join our community on Discord
• Follow the @msftorleans Twitter account for Orleans announcements
• Contributions are welcome! Please review our contribution guidelines
• This project is licensed under the MIT license