Orleans.FSharp.Runtime
5.0.1
dotnet add package Orleans.FSharp.Runtime --version 5.0.1
NuGet\Install-Package Orleans.FSharp.Runtime -Version 5.0.1
<PackageReference Include="Orleans.FSharp.Runtime" Version="5.0.1" />
<PackageVersion Include="Orleans.FSharp.Runtime" Version="5.0.1" />
<PackageReference Include="Orleans.FSharp.Runtime" />
paket add Orleans.FSharp.Runtime --version 5.0.1
#r "nuget: Orleans.FSharp.Runtime, 5.0.1"
#:package Orleans.FSharp.Runtime@5.0.1
#addin nuget:?package=Orleans.FSharp.Runtime&version=5.0.1
#tool nuget:?package=Orleans.FSharp.Runtime&version=5.0.1
Orleans.FSharp.Runtime
F# configuration and hosting support for Orleans silos, clients, and functional grain definitions.
Quick example
open System.Threading.Tasks
open Microsoft.Extensions.Hosting
open Orleans.Hosting
open Orleans.FSharp
open Orleans.FSharp.Runtime
type HealthActor = private HealthActor of unit
[<NoEquality; NoComparison>]
type HealthApi = { ping: unit -> Task<string> }
let healthContract =
grainContract<HealthActor, string, HealthApi> {
grainType "health"
version 1
stringKey
readOnly (_.ping)
}
let healthDefinition =
grainFor healthContract {
defaultState (fun () -> ())
handleQuery (_.ping) (fun _ () () -> task { return "pong" })
}
let config =
siloConfig {
useLocalhostClustering
addMemoryStorage "Default"
addMemoryStreams "StreamProvider"
addMemoryReminderService
enableHealthChecks
}
let builder = HostApplicationBuilder()
SiloConfig.applyToHost config builder
builder.UseOrleans(fun siloBuilder ->
siloBuilder.AddFunctionalGrain(healthDefinition) |> ignore)
|> ignore
let host = builder.Build()
host.Start()
healthDefinition is the sealed value returned by grainFor. Use
AddFunctionalJournaledGrain for journaledGrainFor definitions. A client-only process applies
clientConfig { } and calls AddFunctionalGrainClient() on its IClientBuilder.
Configuration surface
| Category | Current operations |
|---|---|
| Clustering | useLocalhostClustering, addRedisClustering, addAzureTableClustering, addAdoNetClustering |
| Storage | addMemoryStorage, addRedisStorage, addAzureBlobStorage, addAzureTableStorage, addAdoNetStorage, addCosmosStorage, addDynamoDbStorage, addCustomStorage |
| Streaming | addMemoryStreams, addPersistentStreams, addBroadcastChannel |
| Reminders | addMemoryReminderService, addRedisReminderService, addCustomReminderService |
| Security | useTls, useTlsWithCertificate, useMutualTls, useMutualTlsWithCertificate |
| Operations | useSerilog, addDashboard, addDashboardWithOptions, enableHealthChecks, filters, services, and startup tasks |
addDashboardWithOptions takes counterUpdateIntervalMs, historyLength, and hideTrace, in
that order. The optional Microsoft.Orleans.Dashboard package must be referenced by the host.
See Silo configuration, Client configuration, and Dashboard.
Requirements
- .NET 10+
Orleans.FSharp(transitive)
Legacy archive
Some compatibility internals remain temporarily for migration, but the old authoring model is unsupported and receives no 5.x feature, compatibility, or security work. Its documentation is isolated under docs/legacy.
License
MIT
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net10.0 is compatible. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
-
net10.0
- FSharp.Control.TaskSeq (>= 1.1.1)
- FSharp.Core (>= 10.1.201)
- FSharp.SystemTextJson (>= 1.4.36)
- FsToolkit.ErrorHandling (>= 5.2.0)
- IcedTasks (>= 0.11.9)
- Microsoft.Extensions.DependencyInjection (>= 10.0.9)
- Microsoft.Extensions.Diagnostics.HealthChecks (>= 10.0.9)
- Microsoft.Extensions.Hosting (>= 10.0.9)
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.9)
- Microsoft.Orleans.BroadcastChannel (>= 10.1.0)
- Microsoft.Orleans.Core.Abstractions (>= 10.1.0)
- Microsoft.Orleans.EventSourcing (>= 10.1.0)
- Microsoft.Orleans.Persistence.Memory (>= 10.1.0)
- Microsoft.Orleans.Reminders (>= 10.1.0)
- Microsoft.Orleans.Runtime (>= 10.1.0)
- Microsoft.Orleans.Sdk (>= 10.1.0)
- Microsoft.Orleans.Serialization.SystemTextJson (>= 10.1.0)
- Microsoft.Orleans.Server (>= 10.1.0)
- Microsoft.Orleans.Streaming (>= 10.1.0)
- Microsoft.Orleans.Transactions (>= 10.1.0)
- Orleans.FSharp (>= 5.0.1)
- Polly (>= 8.7.0)
- Serilog.Extensions.Logging (>= 10.0.0)
- TypeShape (>= 10.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Orleans.FSharp.Runtime:
| Package | Downloads |
|---|---|
|
Orleans.FSharp.Testing
Test utilities for Orleans.FSharp grains — TestHarness, GrainMock, GrainArbitrary (TypeShape-based FsCheck), FsCheckHelpers, and LogCapture. |
|
|
Orleans.FSharp.EventSourcing
Declarative event sourcing for Orleans grains in F# — eventSourcedGrain {} CE with apply/handle and a JournaledGrain bridge. |
GitHub repositories
This package is not used by any popular GitHub repositories.