ZLink Framework .NET Public Contract¶
Language interface table of contents | Spec table of contents
This directory owns the .NET public interface of the server framework. The language-neutral meaning of a feature is defined by the common spec, and this directory fixes the C# types, methods, generic constraints, nullable, and async return types.
| Document | Contract owned |
|---|---|
| interface table of contents | Defines the C# public type, member, nullable annotation, generic constraint, and default per feature. |
| Configuration and host | Defines the ASP.NET Core registration method, package boundary, DI, and startup contract. |
| Topology configuration | Defines RouteMesh, ClientServer, and fanout builder and runtime options. |
| Location configuration and operations | Defines application-facing Location options, readiness, and operational queries. |
| Location/Relocation provider | Defines the generic atomic Location Store and immutable Relocation Store SPI. |
| Host monitoring | Defines host state, Relocate/Shutdown results, and operational status. |
The Stream connector client is a separate package, and the .NET Stream Connector Contract owns its per-language interface.
Contract Application Rules¶
The Framework API, Channel topology, Spot model, Actor model, and Submit and completion define common behavior. The interface documents below define .NET types and signatures.
Cancellation¶
A .NET async operation only receives explicit cancellation when its
signature has a CancellationToken. A method with no token isn't
interpreted as having a cancellation argument. The terminal result after
cancellation follows the
Async Execution Policy.
Verification¶
Contract tests compare the public exports of the source assembly and the actual NuGet package against this directory's signatures. Nullable annotations, defaults, generic constraints, and overloads are also part of the contract.
Regression Tests¶
| Test | Verification scope |
|---|---|
ContractSurfaceCoverage.Fixed_spec_snapshot_matches_every_exported_contract_signature |
Confirms the formal spec snapshot matches the public signatures of the source and package. |
RegressionTests.DotNetContractRegressionTestReferences_Resolve_ToActiveTestMethods |
Confirms the regression tests and E2E scenarios the document points to exist in the current test tree. |
Language interface table of contents | Spec table of contents