aboutsummaryrefslogtreecommitdiff
path: root/internal/cache/clock/doc.go
diff options
context:
space:
mode:
Diffstat (limited to 'internal/cache/clock/doc.go')
-rw-r--r--internal/cache/clock/doc.go9
1 files changed, 9 insertions, 0 deletions
diff --git a/internal/cache/clock/doc.go b/internal/cache/clock/doc.go
new file mode 100644
index 00000000..6f28805b
--- /dev/null
+++ b/internal/cache/clock/doc.go
@@ -0,0 +1,9 @@
+// Package clock provides a concurrent, weight-bounded object cache.
+//
+// The cache is sharded by key,
+// and each shard owns an independent fraction of the total budget.
+// An entry heavier than that per-shard fraction is never admitted,
+// so callers should keep the total budget well above the largest value.
+//
+// Labels: MT-Safe.
+package clock