Name bikeshedding for numeric parameters in ObjectDiffusion

Author: tbagrel1

ouroboros-network-protocols/src/Ouroboros/Network/Protocol/ObjectDiffusion/Inbound.hs

@@ -42,7 +42,7 @@ data ObjectDiffusionInboundPipelined objectId object m a where
 data Collect objectId object
   = -- | The result of 'SendMsgRequestObjectIdsPipelined'. It also carries
     -- the number of objectIds originally requested.
-    CollectObjectIds NumObjectIdsToReq [objectId]
+    CollectObjectIds NumObjectIdsReq [objectId]
   | -- | The result of 'SendMsgRequestObjectsPipelined'. The actual reply only
     -- contains the objects sent, but this pairs them up with the
     -- objects requested. This is because the peer can determine that
@@ -52,18 +52,18 @@ data Collect objectId object
 data InboundStIdle (n :: N) objectId object m a where
   SendMsgRequestObjectIdsBlocking ::
     -- | number of objectIds to acknowledge
-    NumObjectIdsToAck ->
+    NumObjectIdsAck ->
     -- | number of objectIds to request
-    NumObjectIdsToReq ->
+    NumObjectIdsReq ->
     -- | Result if done
     m a ->
     ( NonEmpty objectId ->
       m (InboundStIdle Z objectId object m a)
     ) ->
     InboundStIdle Z objectId object m a
   SendMsgRequestObjectIdsPipelined ::
-    NumObjectIdsToAck ->
-    NumObjectIdsToReq ->
+    NumObjectIdsAck ->
+    NumObjectIdsReq ->
     m (InboundStIdle (S n) objectId object m a) ->
     InboundStIdle n objectId object m a
   SendMsgRequestObjectsPipelined ::

ouroboros-network-protocols/src/Ouroboros/Network/Protocol/ObjectDiffusion/Outbound.hs

@@ -54,8 +54,8 @@ data OutboundStIdle objectId object m a = OutboundStIdle
   { recvMsgRequestObjectIds ::
       forall blocking.
       SingBlockingStyle blocking ->
-      NumObjectIdsToAck ->
-      NumObjectIdsToReq ->
+      NumObjectIdsAck ->
+      NumObjectIdsReq ->
       m (OutboundStObjectIds blocking objectId object m a),
     recvMsgRequestObjects ::
       [objectId] ->

ouroboros-network-protocols/src/Ouroboros/Network/Protocol/ObjectDiffusion/Type.hs

@@ -36,10 +36,10 @@ module Ouroboros.Network.Protocol.ObjectDiffusion.Type
     SingBlockingStyle (..),
     StBlockingStyle (..),
     BlockingReplyList (..),
-    NumObjectIdsToAck (..),
-    NumObjectIdsToReq (..),
-    NumObjectsToReq (..),
-    NumObjectsInFifo (..),
+    NumObjectIdsAck (..),
+    NumObjectIdsReq (..),
+    NumObjectsReq (..),
+    NumObjectsOutstanding (..),
     -- re-exports
     SizeInBytes (..),
   )
@@ -158,33 +158,33 @@ data StBlockingStyle where
   -- | In this state the peer must reply. There is a timeout.
   StNonBlocking :: StBlockingStyle
 
-newtype NumObjectIdsToAck = NumObjectIdsToAck {getNumObjectIdsToAck :: Word16}
+newtype NumObjectIdsAck = NumObjectIdsToAck {getNumObjectIdsToAck :: Word16}
   deriving (Eq, Ord, NFData, Generic)
   deriving newtype (Num, Enum, Real, Integral, Bounded, NoThunks)
   deriving (Semigroup) via (Sum Word16)
   deriving (Monoid) via (Sum Word16)
-  deriving (Show) via (Quiet NumObjectIdsToAck)
+  deriving (Show) via (Quiet NumObjectIdsAck  )
 
-newtype NumObjectIdsToReq = NumObjectIdsToReq {getNumObjectIdsToReq :: Word16}
+newtype NumObjectIdsReq = NumObjectIdsToReq {getNumObjectIdsToReq :: Word16}
   deriving (Eq, Ord, NFData, Generic)
   deriving newtype (Num, Enum, Real, Integral, Bounded, NoThunks)
   deriving (Semigroup) via (Sum Word16)
   deriving (Monoid) via (Sum Word16)
-  deriving (Show) via (Quiet NumObjectIdsToReq)
+  deriving (Show) via (Quiet NumObjectIdsReq  )
 
-newtype NumObjectsToReq = NumObjectsToReq {getNumObjectsToReq :: Word16}
+newtype NumObjectsReq = NumObjectsToReq {getNumObjectsToReq :: Word16}
   deriving (Eq, Ord, NFData, Generic)
   deriving newtype (Num, Enum, Real, Integral, Bounded, NoThunks)
   deriving (Semigroup) via (Sum Word16)
   deriving (Monoid) via (Sum Word16)
-  deriving (Show) via (Quiet NumObjectsToReq)
+  deriving (Show) via (Quiet NumObjectsReq  )
 
-newtype NumObjectsInFifo = NumObjectsInFifo {getNumObjectsInFifo :: Word16}
+newtype NumObjectsOutstanding = NumObjectsInFifo {getNumObjectsInFifo :: Word16}
   deriving (Eq, Ord, NFData, Generic)
   deriving newtype (Num, Enum, Real, Integral, Bounded, NoThunks)
   deriving (Semigroup) via (Sum Word16)
   deriving (Monoid) via (Sum Word16)
-  deriving (Show) via (Quiet NumObjectsInFifo)
+  deriving (Show) via (Quiet NumObjectsOutstanding)
 
 -- | There are some constraints of the protocol that are not captured in the
 -- types of the messages, but are documented with the messages. Violation
@@ -252,9 +252,9 @@ instance Protocol (ObjectDiffusion initAgency objectId object) where
     MsgRequestObjectIds ::
       forall (blocking :: StBlockingStyle) initAgency objectId object.
       SingBlockingStyle blocking ->
-      NumObjectIdsToAck ->
+      NumObjectIdsAck ->
       -- \^ Acknowledge this number of outstanding objects
-      NumObjectIdsToReq ->
+      NumObjectIdsReq ->
       -- \^ Request up to this number of object ids
       Message (ObjectDiffusion initAgency objectId object) StIdle (StObjectIds blocking)
     -- \| Reply with a list of object identifiers for available objects, along

ouroboros-network/src/Ouroboros/Network/NodeToNode.hs

@@ -102,7 +102,7 @@ import Ouroboros.Network.Server.RateLimiting
 import Ouroboros.Network.Snocket
 import Ouroboros.Network.Socket
 import Ouroboros.Network.Util.ShowProxy (ShowProxy, showProxy)
-import Ouroboros.Network.Protocol.ObjectDiffusion.Type (NumObjectsInFifo)
+import Ouroboros.Network.Protocol.ObjectDiffusion.Type (NumObjectsOutstanding)
 
 
 -- The Handshake tracer types are simply terrible.
@@ -162,7 +162,7 @@ data MiniProtocolParameters = MiniProtocolParameters {
       -- ^ maximal number of unacked tx (pipelining is bounded by twice this
       -- number)
 
-      perasCertDiffusionMaxFifoLength :: !NumObjectsInFifo
+      perasCertDiffusionMaxFifoLength :: !NumObjectsOutstanding
     -- ^ Maximum number of PerasCerts in the outbound peer's outstanding FIFO.
     --
     -- This indirectly limits the number of pipelined requests from the inbound peer: