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

2 files changed, 31 insertions, 7 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
diff --git a/tests/Network/BitTorrent/DHT/MessageSpec.hs b/tests/Network/BitTorrent/DHT/MessageSpec.hs
index 0d84c919..4ec875dd 100644
--- a/tests/Network/BitTorrent/DHT/MessageSpec.hs
+++ b/tests/Network/BitTorrent/DHT/MessageSpec.hs
@@ -7,6 +7,7 @@ import Data.BEncode as BE
 import Data.ByteString.Lazy as BL
 import Data.Default
 import Data.List as L
+import Data.Maybe
 import Network.BitTorrent.Core
 import Network.BitTorrent.DHT.Message
 import qualified Network.KRPC as KRPC (def)
@@ -57,12 +58,13 @@ spec :: Spec
 spec = do
  context ("you need running DHT node at " ++ show remoteAddr) $ do
   it "is running" $ do
-         _ <- retry 5 $ timeout (100 * 1000) $ do
+         running <- retry 5 $ timeout (100 * 1000) $ do
                       nid <- genNodeId
                       Response _remoteAddr Ping <-
                           rpc (query remoteAddr (Query nid Ping))
                       return ()
-         return ()
+         running `shouldSatisfy` isJust
+
   describe "ping" $ do
     it "properly bencoded" $ do
       BE.decode "d2:id20:abcdefghij0123456789e"