From 3d72d8c3f7e91e10b946b443c449f23a2c9a0689 Mon Sep 17 00:00:00 2001
From: David Stainton <dstainton@elixxir.io>
Date: Tue, 11 Oct 2022 12:17:34 -0400
Subject: [PATCH] Add obligatory comments as per review
---
cmix/timeTracker/timeTracker.go | 5 +++++
1 file changed, 5 insertions(+)
diff --git a/cmix/timeTracker/timeTracker.go b/cmix/timeTracker/timeTracker.go
index c3dd19882..67b0017a9 100644
--- a/cmix/timeTracker/timeTracker.go
+++ b/cmix/timeTracker/timeTracker.go
@@ -27,6 +27,8 @@ type TimeOffsetTracker interface {
Aggregate() time.Duration
}
+// gatewayDelays is a helper type used by the timeOffsetTracker below
+// to keep track of the last maxHistogramSize number of durations.
type gatewayDelays struct {
lock sync.RWMutex
delays []*time.Duration
@@ -57,6 +59,7 @@ func (g *gatewayDelays) Average() time.Duration {
return average(g.delays)
}
+// timeOffsetTracker implements the TimeOffsetTracker
type timeOffsetTracker struct {
gatewayClockDelays *sync.Map // id.ID -> *gatewayDelays
@@ -75,6 +78,7 @@ func New() TimeOffsetTracker {
return t
}
+// Add implements the Add method of the TimeOffsetTracker interface.
func (t *timeOffsetTracker) Add(gwID *id.ID, startTime, rTs time.Time, rtt, gwD time.Duration) {
delay := rtt/2 - gwD
@@ -99,6 +103,7 @@ func (t *timeOffsetTracker) addOffset(offset time.Duration) {
}
}
+// Aggregate implements the Aggregate method fo the TimeOffsetTracker interface.
func (t *timeOffsetTracker) Aggregate() time.Duration {
t.lock.RLock()
defer t.lock.RUnlock()
--
GitLab