From 88028412bdfed6daf3fd3002a859a0f5002e6de5 Mon Sep 17 00:00:00 2001 From: J H Date: Mon, 4 Mar 2024 14:18:20 -0700 Subject: [PATCH] chore: Add some documentation for the service actor seed --- core/startos/src/service/mod.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/core/startos/src/service/mod.rs b/core/startos/src/service/mod.rs index b5a9c4bb2..5dba4cdb4 100644 --- a/core/startos/src/service/mod.rs +++ b/core/startos/src/service/mod.rs @@ -398,11 +398,17 @@ struct RunningStatus { pub(self) struct ServiceActorSeed { ctx: RpcContext, id: PackageId, + // Needed to interact with the container for the service persistent_container: PersistentContainer, + // Setting this value causes the service actor to try to bring the service to the specified state. This is done in the background job created in ServiceActor::init desired_state: watch::Sender, + // Override the current desired state for the service during a transition (this is protected by a guard that sets this value to null on drop) temp_desired_state: TempDesiredState, + // This represents a currently running task that affects the service's shown state, such as BackingUp or Restarting. transition_state: Arc>>, + // This contains the start time and health check information for when the service is running. Note: Will be overwritting to the db, running_status: watch::Receiver>, + // This is notified every time the background job created in ServiceActor::init responds to a change synchronized: Arc, }