]> Sergey Matveev's repositories - btrtrc.git/commitdiff
Move request strategy doc comments onto their public functions
authorMatt Joiner <anacrolix@gmail.com>
Sat, 19 Dec 2020 03:43:21 +0000 (14:43 +1100)
committerMatt Joiner <anacrolix@gmail.com>
Sun, 20 Dec 2020 23:18:00 +0000 (10:18 +1100)
(cherry picked from commit 8c059ae1583f48e295fd69001aae9eee4b721ba6)

request-strategy.go

index 2cb03bacd1ceae44ac5c00c827b7f13438dab58f..07d0cce6005eaf3e399bda60afd6cd3701a27e85 100644 (file)
@@ -55,14 +55,10 @@ type requestStrategyCallbacks interface {
        requestTimedOut(request)
 }
 
-// Favour higher priority pieces with some fuzzing to reduce overlaps and wastage across
-// connections.
 type requestStrategyFuzzing struct {
        requestStrategyDefaults
 }
 
-// The fastest connection downloads strictly in order of priority, while all others adhere to their
-// piece inclinations.
 type requestStrategyFastest struct {
        requestStrategyDefaults
 }
@@ -73,10 +69,14 @@ func newRequestStrategyMaker(rs requestStrategy) requestStrategyMaker {
        }
 }
 
+// The fastest connection downloads strictly in order of priority, while all others adhere to their
+// piece inclinations.
 func RequestStrategyFastest() requestStrategyMaker {
        return newRequestStrategyMaker(requestStrategyFastest{})
 }
 
+// Favour higher priority pieces with some fuzzing to reduce overlaps and wastage across
+// connections.
 func RequestStrategyFuzzing() requestStrategyMaker {
        return newRequestStrategyMaker(requestStrategyFuzzing{})
 }
@@ -94,8 +94,6 @@ func (requestStrategyFastest) shouldRequestWithoutBias(cn requestStrategyConnect
        return false
 }
 
-// Requests are strictly by piece priority, and not duplicated until duplicateRequestTimeout is
-// reached.
 type requestStrategyDuplicateRequestTimeout struct {
        requestStrategyDefaults
        // How long to avoid duplicating a pending request.
@@ -113,6 +111,8 @@ type requestStrategyDuplicateRequestTimeout struct {
 // Generates a request strategy instance for a given torrent. callbacks are probably specific to the torrent.
 type requestStrategyMaker func(callbacks requestStrategyCallbacks, clientLocker sync.Locker) requestStrategy
 
+// Requests are strictly by piece priority, and not duplicated until duplicateRequestTimeout is
+// reached.
 func RequestStrategyDuplicateRequestTimeout(duplicateRequestTimeout time.Duration) requestStrategyMaker {
        return func(callbacks requestStrategyCallbacks, clientLocker sync.Locker) requestStrategy {
                return requestStrategyDuplicateRequestTimeout{