Orleans.Lattice.Api.State
9.9.0
dotnet add package Orleans.Lattice.Api.State --version 9.9.0
NuGet\Install-Package Orleans.Lattice.Api.State -Version 9.9.0
<PackageReference Include="Orleans.Lattice.Api.State" Version="9.9.0" />
<PackageVersion Include="Orleans.Lattice.Api.State" Version="9.9.0" />
<PackageReference Include="Orleans.Lattice.Api.State" />
paket add Orleans.Lattice.Api.State --version 9.9.0
#r "nuget: Orleans.Lattice.Api.State, 9.9.0"
#:package Orleans.Lattice.Api.State@9.9.0
#addin nuget:?package=Orleans.Lattice.Api.State&version=9.9.0
#tool nuget:?package=Orleans.Lattice.Api.State&version=9.9.0
Orleans.Lattice.Api.State
Optional read-only cluster state API add-on for Orleans.Lattice. It is the outward-facing read surface of a lattice cluster: external clients can query, observe, and subscribe to live state and metadata over a transport-agnostic facade, without any mutation path.
What it gives you
- Discovery - deterministic, paged catalogs of every registered tree, materialised view, and tag index, with optional per-view stats and tag-index browsing.
- Structure - walk a tree's shard-root node graph: per-shard roots, child fan-out, depth, and live-key subtree counts, bounded by depth/node limits.
- Entry inspection - key-ordered entry scans, snapshot-isolated by default or through a cheaper live cursor (forward or reverse, predicate-filtered, value-preview-budgeted), and single-key record fetch.
- Change history - a single key's continuation-paged revision timeline, bounded by the tree's durable-history retention, or by the retained write-ahead-log window when the tree has no history view.
- Change observation - a server-streamed feed of a tree's live mutations (sets, deletes, range deletes).
- Metrics observation - a one-shot per-tree snapshot or a delta-coalesced live feed of live keys, shard count, shard hotness, and view lag.
- Dead letters and cluster info - read-only strict-mode dead-letter counts and pages, and the connected cluster's identity.
- Read-only by construction - no write, delete, split, or reconfigure verb exists anywhere on the surface.
- Low ambient cost - zero cost when unregistered, negligible when idle; concurrent subscribers to the same request share one sampling loop.
Layered on top of AddLattice(...) with a single opt-in call:
siloBuilder
.AddLattice((silo, name) => silo.AddMemoryGrainStorage(name))
.AddLatticeStateApi();
For remote access, pair it with Orleans.Lattice.Api.State.Grpc, the code-first gRPC binding and typed client over the same Orleans-serialized records. The facade is intended to back a tree-explorer dashboard and the Orleans.Lattice.Api.Mcp MCP server.
See the State API documentation for the full surface, security model, and client guide.
| 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
- Microsoft.Orleans.Sdk (>= 10.2.2)
- Orleans.Lattice (>= 9.9.0)
- Orleans.Lattice.Api.Abstractions (>= 9.9.0)
- Orleans.Lattice.Schema (>= 9.9.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 9.9.0 | 45 | 10/2/2026 |
| 9.8.1 | 66 | 9/29/2026 |
| 9.8.0 | 86 | 9/26/2026 |
| 9.7.0 | 98 | 9/21/2026 |
| 9.6.1 | 334 | 9/9/2026 |
| 9.6.0 | 106 | 9/5/2026 |
| 9.5.0 | 102 | 9/2/2026 |
| 9.4.0 | 112 | 8/29/2026 |
| 9.3.0 | 110 | 8/25/2026 |
| 9.2.0 | 114 | 8/23/2026 |
| 9.1.0 | 116 | 8/20/2026 |
| 9.0.0 | 122 | 8/14/2026 |
| 8.0.2 | 123 | 7/27/2026 |
| 8.0.1 | 121 | 7/27/2026 |
| 8.0.0 | 170 | 7/20/2026 |
| 7.9.2 | 128 | 7/17/2026 |
| 7.9.0 | 135 | 7/9/2026 |
| 7.8.0 | 130 | 7/4/2026 |
| 7.7.1 | 120 | 7/2/2026 |