👁 Image
Microsoft.Orleans.Client 10.2.0

Microsoft Orleans Client

Introduction

Microsoft Orleans Client is a metapackage that includes all the necessary components to connect to an Orleans cluster from a client application. It provides a simplified way to set up an Orleans client by providing a single package reference rather than requiring you to reference multiple packages individually.

Getting Started

To use this package, install it via NuGet:

dotnet add package Microsoft.Orleans.Client

Example - Creating an Orleans Client

using Microsoft.Extensions.Hosting;
using Orleans;
using Orleans.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System;
using System.Threading.Tasks;
namespace ExampleGrains;

// Define a grain interface
public interface IMyGrain : IGrainWithStringKey
{
 Task<string> DoSomething();
}


// Create a client
var builder = Host.CreateApplicationBuilder(args)
 .UseOrleansClient(client =>
 {
 client.UseLocalhostClustering();
 });

var host = builder.Build();
await host.StartAsync();

// Get a reference to a grain and call it
var client = host.Services.GetRequiredService<IClusterClient>();
var grain = client.GetGrain<IMyGrain>("my-grain-id");
var result = await grain.DoSomething();

// Print the result
Console.WriteLine($"Result: {result}");

// Keep the host running until the application is shut down
await host.WaitForShutdownAsync();

Documentation

For more comprehensive documentation, please refer to:

• Microsoft Orleans Documentation
• Orleans client configuration
• Grain references
• Orleans request context

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