comments

src/Network/GRPC/LowLevel/Client.hs

@@ -1,5 +1,8 @@
 {-# LANGUAGE RecordWildCards #-}
 
+-- | This module defines data structures and operations pertaining to registered
+-- clients using registered calls; for unregistered support, see
+-- `Network.GRPC.LowLevel.Client.Unregistered`.
 module Network.GRPC.LowLevel.Client where
 
 import           Control.Exception                     (bracket, finally)

src/Network/GRPC/LowLevel/CompletionQueue.hs

@@ -3,6 +3,12 @@
 -- cause race conditions, so we only expose functions that are thread safe.
 -- However, some of the functions we export here can cause memory leaks if used
 -- improperly.
+--
+-- When definition operations which pertain to calls, this module only provides
+-- definitions for registered calls; for unregistered variants, see
+-- `Network.GRPC.LowLevel.CompletionQueue.Unregistered`. Type definitions and
+-- implementation details to both are kept in
+-- `Network.GRPC.LowLevel.CompletionQueue.Internal`.
 
 {-# LANGUAGE RecordWildCards #-}
 

src/Network/GRPC/LowLevel/Op.hs

@@ -221,11 +221,10 @@ runOps call cq ops timeLimit =
 
 -- | For a given call, run the given 'Op's on the given completion queue with
 -- the given tag. Blocks until the ops are complete or the given number of
--- seconds have elapsed.
+-- seconds have elapsed.  TODO: now that we distinguish between different types
--- TODO: now that 'ServerRegCall' and 'U.ServerCall' are separate types, we
+-- of calls at the type level, we could try to limit the input 'Op's more
--- could try to limit the input 'Op's more appropriately. E.g., we don't use
+-- appropriately. E.g., we don't use an 'OpRecvInitialMetadata' when receiving a
--- an 'OpRecvInitialMetadata' when receiving a registered call, because gRPC
+-- registered call, because gRPC handles that for us.
--- handles that for us.
 runServerRegOps :: ServerRegCall
                 -- ^ 'Call' that this batch is associated with. One call can be
                 -- associated with many batches.

src/Network/GRPC/LowLevel/Server.hs

@@ -1,5 +1,8 @@
 {-# LANGUAGE RecordWildCards #-}
 
+-- | This module defines data structures and operations pertaining to registered
+-- servers using registered calls; for unregistered support, see
+-- `Network.GRPC.LowLevel.Server.Unregistered`.
 module Network.GRPC.LowLevel.Server where
 
 import           Control.Exception                       (bracket, finally)