document updateContainers internal timeout

mafredri · mafredri · commit 0455dd90ab51 · 2025-05-22T09:12:24.000Z
diff --git a/agent/agentcontainers/api.go b/agent/agentcontainers/api.go
@@ -293,6 +293,8 @@ func (api *API) updaterLoop() {
 		case <-api.ctx.Done():
 			return
 		case done := <-api.updateTrigger:
+			// Note that although we pass api.ctx here, updateContainers
+			// has an internal timeout to prevent long blocking calls.
 			done <- api.updateContainers(api.ctx)
 		}
 	}

Original file line number	Diff line number	Diff line change
`@@ -293,6 +293,8 @@ func (api *API) updaterLoop() {`
`293`	`293`	`case <-api.ctx.Done():`
`294`	`294`	`return`
`295`	`295`	`case done := <-api.updateTrigger:`
	`296`	`+ // Note that although we pass api.ctx here, updateContainers`
	`297`	`+ // has an internal timeout to prevent long blocking calls.`
`296`	`298`	`done <- api.updateContainers(api.ctx)`
`297`	`299`	`}`
`298`	`300`	`}`