Skip to main content

Module topology

Module topology 

Source
Expand description

Control-path identities and explicit adoption of a legacy sealed catalog.

Adoption changes the authority encoding, not the processing graph. Runtime migrations must still establish a checkpoint cut, validate state mappings and commit coordinated release.

Structs§

ClusterTopologyObjectPlan
One catalog-bound entry of the local compatibility descriptor, sorted by canonical name.
ClusterTopologyValidation
Effect-free candidate validation. This is neither a durable admission nor an activation receipt.
LegacyTopologyBaseline
Immutable identity of the existing inventory at the authority format upgrade.
TopologyActivation
A single current installation round. A replacement leader may supersede an unreleased round; it must collect every runtime again. A published Release is immutable.
TopologyAdmissionPlan
Exact request and assignment evidence reserved before checkpoint cutover.
TopologyAdmissionStatus
Durable status of one payload-bound request, including its optional target catalog decision.
TopologyCheckpointCut
Binding installed atomically with artifact admission, before any source barrier is injected.
TopologyCommit
The exact shared append that changed the committed catalog. The containing operation’s immutable plan, root, cut, descriptor and complete preparation roster bind this decision. This does not prove installation or authorize output, sink succession or intake release.
TopologyCompatibilityRef
Immutable canonical candidate report. The report is separate from authority renewals.
TopologyCutCommit
Exact old-topology Commit retained while a cut is prepared.
TopologyInstallationReceipt
One still-held runtime observed by its owning process. Connector children remaining after actor exit are termination obligations, never readiness evidence.
TopologyJournalUsage
Occupancy of the bounded topology request journal. Every admitted request, including Active and Aborted ones, keeps its identity so a retry returns its original outcome. Admission is rejected once retained reaches capacity; terminal-prefix compaction is not implemented.
TopologyMigrationRoot
Immutable target restore/initialization requirements, retained by one authority append. All state ranges, source/snapshot/channel progress, sink decisions and replay segment references remain in the exact old checkpoint. No historical manifest or state payload is rewritten.
TopologyMigrationRootBinding
Durable staging evidence. Neither this binding nor CutPrepared commits the target catalog.
TopologyMigrationRootRef
Small content reference carried by authority renewals.
TopologyOperationId
Durable request identity for a topology operation.
TopologyParticipantCertificate
One process’s independently compiled candidate, bound to its first immutable authority append.
TopologyPlanRef
Small immutable plan reference carried by authority renewals.
TopologyPreparation
Candidate binding retained by admission, renewals, cut preparation and definitive abort.
TopologyPreservedObject
Same catalog incarnation and ABI mapped to the same checkpoint state slot.
TopologyRecoveryBinding
Immutable target of an existing coordinated recovery round. Its cut is selected only after the complete stopped quorum; binding the target earlier prevents a catalog/Prepare race.
TopologyRecoveryInput
An audited choice of recovery cut, bound to the current target and local process adoption. Construction belongs to the shared authority. This grants private state reads only; actor installation and intake require a fresh coordinated recovery round and its complete quorum.
TopologyRelease
Durable permission to activate the complete installation roster. This is separate from local gate opening; each process must still validate its own installed runtime and authority.
TopologyRestoreInput
A live read of the exact prepared operation, cut and local ownership. Only the configured controller/authority can construct this input. It permits private restore preparation, never graph installation, source start, output or intake release. A retained input can become stale; installation must revalidate authority and require a target Commit/Release.
TopologySourceInitialization
One new catalog incarnation’s exact position before any participant consumes input. The existing connector cursor encoding preserves never-read partitions without inventing a consumed offset, checkpoint attempt or assignment ownership. Target installation must validate this cursor through the connector and adopt only its assigned channels before releasing intake.
TopologySubscriptionRoot
Unchanged subscription identity and exclusive sequence vector at the old cut.
TopologyTargetPreparationReceipt
One process restored the bound target and observed all its parent actors terminal. The operation’s immutable plan/root/cut bind the observation. It is historical evidence, not proof that an image is still resident, receivers/sinks are installed or intake may open.
TopologyVersion
Logical topology version, independent of catalog/checkpoint serialization versions.

Enums§

ClusterTopologyObjectTransition
Supported catalog-object transitions at an exact checkpoint cut.
TopologyAbortReason
Definitive disposition of an operation that has not started cutover.
TopologyActivationRequirement
Authorization still needed before this local plan can activate a target graph.
TopologyAdmissionPhase
Old-topology preparation states. No state here authorizes the candidate graph.
TopologyAdoptionOutcome
Result of one explicit format upgrade, including the original winner on an identical retry.
TopologyCatalogState
Durable catalog state; missing version metadata is never an implicit current version.
TopologyError
Typed, stable control-path failures. No error authorizes a topology or state fallback.
TopologyInitialization
Required initialization semantics. These are requirements, never concrete cut positions.
TopologyRecoveryCut
Which exact durable cut supplies a committed target’s private state image.
TopologyValidationScope
What a successful validation proves. Participant agreement and runtime authorization follow.

Constants§

MAX_TOPOLOGY_OPERATIONS
Maximum retained request identities until topology journal retention is implemented.
MAX_TOPOLOGY_ROOT_MANIFEST_BYTES
Aggregate manifest metadata admitted while staging a root; state/output payloads are not read.
MAX_TOPOLOGY_SOURCE_CHANNELS
Maximum physical input channels in one new source’s initial inventory.
TOPOLOGY_COMMIT_PROTOCOL_VERSION
Every frozen participant must support Commit and explicit migration-root reconstruction.
TOPOLOGY_INSTALLATION_PROTOCOL_VERSION
Requires held actors, generation-fenced completions and exact installation receipts.
TOPOLOGY_PREPARATION_PROTOCOL_VERSION
Candidate preparation requires this exact protocol on every frozen process.
TOPOLOGY_PROTOCOL_VERSION
Version of the topology adoption protocol understood by this binary.
TOPOLOGY_RECOVERY_PROTOCOL_VERSION
Recovery rounds carrying a topology Commit require every exact participant to understand that binding. Older round decoders reject the additional field rather than recover a parent.
TOPOLOGY_SUBMISSION_PROTOCOL_VERSION
Complete public migration support, including exact-target installation and recovery. Every frozen process must certify this plan protocol before the parent cut begins.
TOPOLOGY_TARGET_PREPARATION_PROTOCOL_VERSION
Every reporting process must implement target restore and observed parent retirement.