Class RealmRegistry

Namespace

Typhon.Engine

Assembly

Typhon.Engine.dll

The engine's realms: how many it can host and which are registered. Reached through Realms.

public sealed class RealmRegistry

Inheritance

object

RealmRegistry

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Realms are registered before InitializeArchetypes, after ConfigureRealms(int) has sized the table: the spatial rebuild at open needs every realm's grid. Registering at run time (instances, houses) lands with the realm lifecycle work.

Properties

Counts

How many registered realms are in each run state this tick, and how many run at a divisor (Realms D6). Before InitializeArchetypes, all zero.

public RealmStateCounts Counts { get; }

Property Value

RealmStateCounts

MaxRealms

The configured realm count: valid ids are [0, MaxRealms).

public int MaxRealms { get; }

Property Value

int

Methods

DestroyContents(RealmId, Transaction)

Destroys every entity in realm id through tx, on the ordinary destroy path. Returns how many. Commit the transaction; the next fence frees the realm's clusters (and removes a Closing realm once nothing is left).

public int DestroyContents(RealmId id, Transaction tx)

Parameters

id RealmId

tx Transaction

Returns

int

IsRegistered(RealmId)

True when id is registered (pending registrations count before InitializeArchetypes).

public bool IsRegistered(RealmId id)

Parameters

id RealmId

Returns

bool

Observe(RealmId)

Pins realm id active — observed, simulated at full rate — from the next tick on, until the returned handle is disposed. For an application with no session in the realm (a headless server, a benchmark, a test); sessions observe through replication.

public RealmObserver Observe(RealmId id)

Parameters

id RealmId

Returns

RealmObserver

Exceptions

InvalidOperationException

Before InitializeArchetypes, or id is not registered.

Register(RealmId, RealmConfig)

Registers realm id. Refused when the id is out of range or already registered, or the config is invalid.

public void Register(RealmId id, RealmConfig config)

Parameters

id RealmId

config RealmConfig

Exceptions

InvalidOperationException

After InitializeArchetypes (run-time registration is not supported yet), or a duplicate.

StateOf(RealmId)

What realm id is doing this tick, as its policy decided at tick start.

public RealmRunState StateOf(RealmId id)

Parameters

id RealmId

Returns

RealmRunState

Remarks

A realm Unregister has closed reads Closing at once: entries are refused from the call on. Its policy state — what dispatch reads — follows at the next tick start (RLM-03).

Unregister(RealmId)

Unregisters realm id on a running engine (Realms D5): it is Closing from now on — no entity may enter it — and is removed at the first fence that finds it empty. Empty it with DestroyContents(RealmId, Transaction). Its id may be registered again only after a later open (RLM-06). The primary realm cannot be unregistered.

public void Unregister(RealmId id)

Parameters

id RealmId

Wake(RealmId)

Wakes realm id: simulated from the next tick on, and a Sleep realm holds for its SleepAfterTicks again before it may go dormant. Any thread.

public void Wake(RealmId id)

Parameters

id RealmId