Nebula
Control plane

ScopeInfo

A shared simulation scope the mesh has been asked to bring into being: the opaque key that names it, the definition it was activated from, and the containers that now exist for it.

generated from the sources
public sealed class ScopeInfo

A shared simulation scope the mesh has been asked to bring into being: the opaque key that names it, the definition it was activated from, and the containers that now exist for it. One row per key, mirrored to every worker, gateway and orchestrator in the control-plane document.

Fields

ScopeKey

public string ScopeKey = "";

The opaque key. Never empty (the public world is EntityLocation.PublicScope and is never activated).

InstanceId

public ulong InstanceId;

The scope's 64-bit isolation id (ScopeKeys.Hash), the same value entities carry in NetworkIdentity.InstanceId.

State

public string State = ScopeState.Active;

See ScopeState.

ContainerIds

public List<string> ContainerIds = new List<string>();

The scope's container ids, in definition order (ScopeKeys.ContainerId).

Definition

public ScopeDefinition Definition = new ScopeDefinition();

The definition the first activation won with. A later activation with a different one is refused.

CreatedAt, UpdatedAt

public DateTime CreatedAt, UpdatedAt;

When the row was created, and when it was last activated. The idle sweep aggregates over these rows.

StateSince

public DateTime StateSince;

When State last changed. The orchestrator's retire and restore deadlines run from here.

Acks

public List<ScopeAck> Acks = new List<ScopeAck>();

What the parts have finished, one entry per container at most (ScopeAck). Cleared on every state change, so an ack always belongs to the step that is running now.

Requester

public string Requester = "";

Who last asked for it, for logs and the dashboard. Free-form; Nebula attaches no meaning to it.

Methods

FindAck

public ScopeAck FindAck(string containerId, string phase);

The acknowledgement for containerId in phase, or null.

AllAcked

public bool AllAcked(string phase);

Every container of the scope has acknowledged phase.

AckedCount

public int AckedCount(string phase);

The acknowledged counts for phase, summed over the parts.

On this page