docs/generated/vocabulary.mdgenerated from code

Reference · 12 min read

actor_kind

Vocabulary: actor_kind.

Kinds of actor. Every Context::KIND is one of these values. Also the actor_kind telemetry attribute.

ValueMeaning
documentOne per Loro document of any kind (discussion:owner/457).
routerThe radix namespace router (discussion:owner/561).
stuck_listerOne per project: the list of documents holding changes they can't take in, which status reads, fed by the router (o-decouple/8).
tree_fileOne per tree directory: the project root and each main tree (discussion:owner/221).
syncThe one sync actor per daemon (discussion:owner/30 and discussion:owner/68; lane M3.sync): one /lvcs/sync/<wire major> stream per node pair, carrying tagged sync messages for every document, .lvcs/caps first, between the transport and the document actors.
gossipThe one gossip actor per daemon (discussion:owner/111; lane M3.gossip): topic membership, validation of every received message before it is forwarded, and node-scoring inputs.
boardOne per document with presence or notifications (discussion:owner/438; lane M3.coord), key the document's address: who is present, the bulletin, presence publishing, a save's automatic announcement, and the overlap question.
signerA signer machine, one per signer key the daemon meters (discussion:owner/40 and discussion:owner/439; lane M3.grants): that signer's token buckets for gossip forwarding and for the daemon's signing rate, and its waiting takes.
transportThe one transport actor per daemon run (discussion:owner/222; lane M3.transport), stepped inline by the transport shell: whom to dial and redial, what goes into the DHT, relay reservations, and which side opens a node pair's sync stream.
runnerThe one runner actor per daemon (discussion:owner/121, discussion:owner/142, and discussion:owner/245; lane M5.validator), key "": for the change actions' channels it serves, it prepares main's visible frontier, runs the change actions it can't reuse, and attests each channel once all of its actions pass (discussion:owner/297); for each gated action's channel, it picks the runner of each pending run from the runners' presences and records each run's outcome. What it serves comes from its peer's grants, any set of channels, never a mode.
frontierOne per frontier with work on it (discussion:owner/437; lane M5.validator), key the frontier's id: its attestations by change channel, their counted sizes (discussion:owner/120), and the approvals naming it, which it gates (discussion:owner/122).
channelOne per channel of the policy in force (discussion:owner/297 and discussion:owner/437; lane M5.validator), key its name: its value, moving only forward, and for a gated action's channel its run requests, outcomes, and pending run (discussion:owner/141).
protectedOne per protected path (discussion:owner/122 and discussion:owner/437; lane M5.validator), key its address: its approved heads.
carrierOne per approvals segment after the first (discussion:owner/805), key its number: its carries, which of them a matching fold proved, and its opening.
approvals_renderOne per project (discussion:owner/805, r3-actions/20): decides whether the newest approvals segment's render is skipped as owed at open and policy apply (when its router heads match the settled marker in approved.d) and triggers it on demand before has_approval or approved_version needs historical gates.
channel_runsOne per channel (discussion:owner/303, discussion:owner/312, discussion:owner/321, and discussion:owner/437; lane M5.validator), key its name: its runs, its value's moves, and its runners' presences, which outlast a new policy's channel machines.
sandbox_turnsOne per daemon (discussion:owner/168, discussion:owner/272, and discussion:owner/436), key "": its sandbox slots over every project it hosts (retired, discussion:owner/532), handed to the steps that ask, oldest first.
gated_runOne per gated run (discussion:owner/168, discussion:owner/357, and discussion:owner/437), key its run key: its reads, preparation, command, outcome, and end.
gated_turnOne per project (discussion:owner/168), key "": the turn its gated runs hold its run executor by, one at a time, oldest first.
inboxThe inbox actor (discussion:owner/118 and discussion:owner/513; daemon/mailbox.rs): the notifications pending for each local peer, kept when they match its interest, listed by notifications (lvcs notify), and read by notifications.read.
lifecycleThe daemon's lifecycle actor (discussion:owner/211 and discussion:owner/222), run inline by the shell: starting, joining, ready, draining, and stopped, with policy and caps known or not as context facts.
intakeThe daemon's save intake actor (discussion:owner/211 and discussion:owner/222), run inline by the shell: held tree saves, first in first out per tree, and their waits on signing tokens.
editsThe daemon's edits actor (discussion:owner/222), run inline by the shell: parked edits and their waits on scans and signing tokens.
renewalsThe daemon's renewals actor (discussion:owner/148, discussion:owner/211, and discussion:owner/222), run inline by the shell: the grants due for renewal and the revocations in flight.
held_keysThe held keys of a project (discussion:owner/439 and discussion:owner/443): which peers' keys the daemon holds, by public key; the private keys are the keyring's alone.
notifyA notify machine, one per announce or track_edit request in flight (discussion:owner/222 and discussion:owner/439): its gossip take, anchor, resolution, and the coord machine's decision.
supersededA superseded machine, one per file address whose render of main hid a head: the hidden heads its authors were told of.
noteOne per notification this daemon published or received ( discussion:owner/222 and 439), key its id: the note, its resolution, and a received one's wait for it.
stopOne per local peer (discussion:owner/214, discussion:owner/217, and discussion:owner/439), key its peer key: its newest changes, shown streaks, and refused saves, and each fresh stop_gate's verdict.
gateOne per stop_gate that asks its documents (discussion:owner/214 and 439), key its request id: the questions, then the recheck.
directoryThe directory actor (discussion:owner/305), run inline by the shell: what the project shows in the tracker's directory (its listing, registry, activity, and the owner's unlist).
snapshotOne per public project (discussion:owner/680), on the host: when its signed public snapshot is published to the edge, and which anonymous reads it answers.
upstreamOne per public project (discussion:owner/681), on the host: its one upstream to the edge, which fans its live stream out to readers.
streaksThe runner's check streaks actor (discussion:owner/203, discussion:owner/211, and 222), run inline by the shell: each check's failing streak.
generationsThe daemon's generations actor, run inline by the shell: the generation main shows, where each derived output stands, and who is told a derivation failed.
change_drainThe change executor's drain actor (discussion:owner/249), run inline by the shell: which job's blocking step is out, and the step a runner that stopped serving change channels discards when it comes back.
admissionThe admission actor (discussion:owner/178 and discussion:owner/211), run inline by the shell: each quota'd grant's change counts, whether a write passes its grant's quota, and whether a run holds its grant.
runOne action's run (discussion:owner/245), run inline by the shell's executor, one incarnation per run: it sequences the action's steps, each one lvcs sandbox exec in one run directory, with what each step wrote to its step files as event data.
hostThe per-user daemon's host actor (discussion:owner/272), run inline by the daemon, one per daemon: the registry of project roots and each project's lifecycle, and where each connection's hello is routed. Journaled in the daemon's state directory, not in any project's journal.
hostedOne hosted project's lifecycle in the per-user daemon (discussion:owner/272), run inline by the daemon, one incarnation per opening: opening or joining, open, failed with its reason, and closing. Journaled beside the host actor.
updaterThe per-user daemon's updater (the updater row), run inline by the daemon, one per daemon: it checks for a signed release, downloads and verifies it, waits for every sandbox to finish, replaces the binary, and restarts the daemon. Journaled beside the host actor.
reachThe project daemon's reach actor (discussion:owner/326), run inline by the shell: which known nodes hold which revocations.
peersThe project daemon's peers machine (owner/18, discussion:owner/436), on the project's scope: the grants the caps document rendered and the peer directory built from them and the keys the daemon holds, answered to each query.
resourcesThe per-user daemon's resources actor (discussion:owner/303), run inline by the daemon: the last hour of its resource samples. Journaled beside the host actor.
load_keeperOne connected node's last node.load answer on a project's daemon (discussion:owner/487): at most one fetch per step, whoever asks. Never journaled: what it keeps is another node's, and a reader's question must cost no write.
rpc_sessionOne remote connection's session on the host node ( discussion:owner/300), run inline by the project's shell, one incarnation per connection: challenged, then serving a paired device, an unpaired device that may only pair, or an anonymous reader, and each request checked against its scope.
connectionOne JSON-RPC connection of the daemon's (owner/15), on the connections' own Tokio scope, one incarnation per connection: its requests in flight and each one's deadline, which answer is written and which comes too late, and when it closes.
clientOne peer's local clients (owner/18), on the project's scope, one per peer per opening: which connections said hello as the peer, and which pushes each already got, so a push sent once reaches each connection once.
pairingOne agentflare auth login (discussion:owner/300), run inline by the project's shell, one incarnation per login: waiting for a device, claimed by one, then confirmed, declined, or expired.
rendezvousThe per-user daemon's rendezvous actor (discussion:owner/327), run inline by the daemon, one per daemon: each WebRTC session a browser offered through the tracker, from accepted or refused, answered, and open to ended. Journaled beside the host actor.
host_nodeThe per-user daemon's host node switch (discussion:owner/300 and 359), run inline by the daemon, one per daemon: whether the host node listens, and what turning it on or off does. Journaled beside the host actor.
watcherA tree's file watcher machine (owner/8), on the project's scope, one per open tree: what the daemon's file watcher saw in its tree, coalesced per path until it settles, and lost events turned into rescans.
rescannerA tree's rescanner (discussion:owner/340), on the project's scope, one per open tree: its rescans after lost events, one running and at most one waiting.
turnsOne per project (discussion:owner/453, net-join/6): how many of its documents' sync imports run at once, the rest waiting in order.
answererOne per bare round of a rested document (channel-judge/5): whether a node's join or sync batch is answered from its stored ledger or loads it; it ends with the round.
resterOne per project (session-29a3231b/2): the stored bytes of its loaded documents, and past LOADED_BYTES_BUDGET its asks that settled ones rest early, one at a time, oldest first.
memory_budgetOne per daemon (owner/762): in-flight byte permits shared by its projects, with deferred asks released by completion events.
openerOne per daemon (daemon-memory/7): the open turn, which one project opening at a time holds while it reads and rebuilds from its journal, the rest waiting in order.
permit_holdingOne file document incarnation's incoming byte charges (owner/762).
alarmOne armed timer (discussion:owner/442): a machine of its own that sleeps until its deadline, sends its owner the firing, and ends; its key names its owner's deadline.
plugin_keeperOne per installed plugin with a serve command (discussion:owner/514), key its name: its background peer's runs, restarted after each exit, replaced by an upgrade, ended by its removal.
plugin_holderOne per plugin keeper (discussion:owner/797), key the plugin's name: the pushes to its key held while no serve could take them, handed to the next serve's connections.
plugin_enablerOne per plugin name a project enables or disables (session-9468d544/35 F3), key its name: its .plugin record's owner, so operations on one name run one after the other.
plugin_cutoverOne per project (session-9468d544/35 F3), key empty: the 0.3.0 cutover's phase, its re-enable and its commit, one at a time.
plugin_upgraderOne per bundled plugin whose record this node holds as the owner (discussion:owner/535), key its name, for one daemon run: whether its manifest on disk is applied at the opening, or the owner told why not.
plugin_admitterOne per daemon (discussion:owner/790 item 3), key empty: the plugins' share of the machine's memory (PLUGINS_RSS_BYTES), each running serve's and admitted command's sampled bytes held against it, the starts waiting for room, and its asks that the quietest serve that opted in rest. Journaled beside the host actor.
plugin_sharedOne per (plugin, binary, serve, version) shared across projects hosted by one daemon (discussion:owner/830, r3-e2e/22): runs ONE background serve process for every project that enables that shared = true plugin binary, routes per-project attach/detach slots, and drains the OS process when every attached project goes dormant or detaches. Journaled beside the host actor.
pluginEvery plugin's machines, in the plugin's own process ( discussion:owner/517): one value whatever is installed, so actor_kind's cardinality stays fixed. The plugin's own machine kind (timekeeper, resolver, ...) is the ActorId key's prefix, which goes to the plugin's local journal only, never to telemetry.
allowlistA project's allowlist machine (discussion:owner/439): the secret hashes the scan doesn't flag, the latest caps render's signed allowlist and those add --force forced since, answered to every scan.
holderOne path's holder (discussion:owner/439 and discussion:owner/513): the tree saves of the path held uncommitted while their refusal's cause lasts, ending once the last is taken.
landerOne path's lander (o-decouple/1, discussion:owner/653): the adds of the path waiting for its save to land on main or be refused, each answered once; ending once the last is answered.
sweeperOne per project opening (session-9468d544/33, discussion:owner/731): deletes the journal's set-asides and old torn tails past their bounds once its decision is in the fresh journal, and ends.
device_standingA device key's standing on this daemon (discussion:owner/623): the running projects that grant it a live device grant, and its open host-level streams; one per key, ending once neither is left.
standingA tree's standing (discussion:owner/349 and discussion:owner/439): whether its saves may be checked now, down while its author can write nothing.
computeA scope's compute machine (discussion:owner/410), one per project scope: the shell's blocking jobs, each counted busy until it ends.
broadcasterOne watched push kind's broadcaster (discussion:owner/303, owner/18), on the project's scope, one per kind watch takes per opening: which connections' watches take the kind, and for activity the recent activity project.summary counts.
retry_windowOne peer's retry window (discussion:owner/163, owner/18), on the project's scope, one per peer per opening: each request id the peer's retried ops sent in the window, in flight with the retries waiting for its answer, answered and kept, or unknown from before the daemon last stopped.
remote_signerOne write device's remote signer (discussion:owner/300), on the project's scope, one per device key per opening: the device's attached connections and each signing request pushed to one, waiting for its auth.sign, until it is answered, its connection goes, or it times out.

Cardinality: 78.