Merge branch 'master' of https://github.com/cobit/bittorrent

1 files changed, 27 insertions, 5 deletions

diff --git a/src/Network/BitTorrent/Tracker/RPC/UDP.hs b/src/Network/BitTorrent/Tracker/RPC/UDP.hs
index db9c32b3..b0f44ec6 100644
--- a/src/Network/BitTorrent/Tracker/RPC/UDP.hs
+++ b/src/Network/BitTorrent/Tracker/RPC/UDP.hs
@@ -60,34 +60,56 @@ import Network.BitTorrent.Tracker.Message
 --  Options
 -----------------------------------------------------------------------}
 
+-- | 'System.Timeout.timeout' specific.
 sec :: Int
 sec = 1000000
 
+-- | See <http://www.bittorrent.org/beps/bep_0015.html#time-outs>
 defMinTimeout :: Int
 defMinTimeout = 15 * sec
 
+-- | See <http://www.bittorrent.org/beps/bep_0015.html#time-outs>
 defMaxTimeout :: Int
 defMaxTimeout = 15 * 2 ^ (8 :: Int) * sec
 
+-- | See: <http://www.bittorrent.org/beps/bep_0015.html#time-outs>
 defMultiplier :: Int
 defMultiplier = 2
 
--- announce request packet
+-- TODO why 98?
 defMaxPacketSize :: Int
 defMaxPacketSize = 98
 
+-- | Manager configuration.
 data Options = Options
-  { optMaxPacketSize :: {-# UNPACK #-} !Int
-
-    -- | in seconds.
+  { -- | Max size of a /response/ packet.
+    --
+    --   'optMaxPacketSize' /must/ be a positive value.
+    --
+    optMaxPacketSize :: {-# UNPACK #-} !Int
+
+    -- | Starting timeout interval. If a response is not received
+    -- after 'optMinTimeout' then 'Manager' repeat RPC with timeout
+    -- interval multiplied by 'optMultiplier' and so on until
+    -- timeout interval reach 'optMaxTimeout'.
+    --
+    --   'optMinTimeout' /must/ be a positive value.
+    --
   , optMinTimeout    :: {-# UNPACK #-} !Int
 
-    -- | in seconds.
+    -- | After 'optMaxTimeout' reached and tracker still not
+    -- responding both 'announce' and 'scrape' functions will throw
+    -- 'TimeoutExpired' exception.
+    --
+    --   'optMaxTimeout' /must/ be greater than 'optMinTimeout'.
+    --
   , optMaxTimeout    :: {-# UNPACK #-} !Int
 
+    -- | 'optMultiplier' must a positive value.
   , optMultiplier    :: {-# UNPACK #-} !Int
   } deriving (Show, Eq)
 
+-- | Options suitable for bittorrent client.
 instance Default Options where
   def = Options
     { optMaxPacketSize = defMaxPacketSize