Add a few misc comments and TODOs

IntersectMBO · May 4, 2021 · b3b66a1 · b3b66a1
1 parent 09c84fb
commit b3b66a1
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/ouroboros-network/src/Ouroboros/Network/PeerSelection/Governor/Monitor.hs b/ouroboros-network/src/Ouroboros/Network/PeerSelection/Governor/Monitor.hs
@@ -88,11 +88,13 @@ jobs jobPool st =
 --
 reconnectDelay :: DiffTime
 reconnectDelay = 10
+--TODO: make this a policy param
 
 -- | Activation delay after a peer was asynchronously demoted to warm state.
 --
 activateDelay :: DiffTime
 activateDelay = 60
+--TODO: make this a policy param
 
 
 -- | Monitor connections.

diff --git a/ouroboros-network/src/Ouroboros/Network/PeerSelection/Governor/Types.hs b/ouroboros-network/src/Ouroboros/Network/PeerSelection/Governor/Types.hs
@@ -500,7 +500,7 @@ data TracePeerSelection peeraddr =
   deriving Show
 
 data DebugPeerSelection peeraddr peerconn =
-       TraceGovernorState Time
-                          (Maybe DiffTime)
+       TraceGovernorState Time              -- blocked time
+                          (Maybe DiffTime)  -- wait time
                           (PeerSelectionState peeraddr peerconn)
   deriving (Show, Functor)
diff --git a/ouroboros-network/src/Ouroboros/Network/PeerSelection/KnownPeers.hs b/ouroboros-network/src/Ouroboros/Network/PeerSelection/KnownPeers.hs
@@ -352,7 +352,7 @@ minConnectTime KnownPeers { nextConnectTimes }
 
 
 setConnectTime :: Ord peeraddr
-               => Set peeraddr
+               => Set peeraddr --TODO: make this a single entry
                -> Time
                -> KnownPeers peeraddr
                -> KnownPeers peeraddr

diff --git a/ouroboros-network/test/Test/Ouroboros/Network/PeerSelection.hs b/ouroboros-network/test/Test/Ouroboros/Network/PeerSelection.hs
@@ -1591,6 +1591,12 @@ selectEnvTargets f =
 -- Live examples
 --
 
+-- | Run the 'publicRootPeersProvider' in IO with a stdout tracer to observe
+-- what it does.
+--
+-- This is a manual test that runs in IO and has to be observed to see that it
+-- is doing something sensible. It is not run automatically.
+--
 _governorFindingPublicRoots :: Int -> [DomainAddress] -> IO Void
 _governorFindingPublicRoots targetNumberOfRootPeers domains =
     withTimeoutSerial $ \timeout ->