status-im/go-libp2p-pubsub
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

godoc nits for parameter weights.

Browse Source
This commit is contained in:
vyzo 2020-03-27 14:19:03 +02:00
parent bb279e3126
commit 65cff1b421
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
score_params.go
View File

@ -77,7 +77,7 @@ type TopicScoreParams struct {
// P1: time in the mesh // P1: time in the mesh
// This is the time the peer has ben grafted in the mesh. // This is the time the peer has ben grafted in the mesh.
// The value of of the parameter is the time/TimeInMeshQuantum, capped by TimeInMeshCap // The value of of the parameter is the time/TimeInMeshQuantum, capped by TimeInMeshCap
// The weight of the parameter MUST be positive. // The weight of the parameter MUST be positive (or zero to disable).
TimeInMeshWeight float64 TimeInMeshWeight float64
TimeInMeshQuantum time.Duration TimeInMeshQuantum time.Duration
TimeInMeshCap float64 TimeInMeshCap float64
@ -86,7 +86,7 @@ type TopicScoreParams struct {
// This is the number of message deliveries in the topic. // This is the number of message deliveries in the topic.
// The value of the parameter is a counter, decaying with FirstMessageDeliveriesDecay, and capped // The value of the parameter is a counter, decaying with FirstMessageDeliveriesDecay, and capped
// by FirstMessageDeliveriesCap. // by FirstMessageDeliveriesCap.
// The weight of the parameter MUST be positive. // The weight of the parameter MUST be positive (or zero to disable).
FirstMessageDeliveriesWeight, FirstMessageDeliveriesDecay float64 FirstMessageDeliveriesWeight, FirstMessageDeliveriesDecay float64
FirstMessageDeliveriesCap float64 FirstMessageDeliveriesCap float64
@ -103,7 +103,7 @@ type TopicScoreParams struct {
// If the counter is below the MeshMessageDeliveriesThreshold, the value is the square of // If the counter is below the MeshMessageDeliveriesThreshold, the value is the square of
// the deficit, ie (MessageDeliveriesThreshold - counter)^2 // the deficit, ie (MessageDeliveriesThreshold - counter)^2
// The penalty is only activated after MeshMessageDeliveriesActivation time in the mesh. // The penalty is only activated after MeshMessageDeliveriesActivation time in the mesh.
// The weight of the parameter MUST be negative (or zero if you want to disable it). // The weight of the parameter MUST be negative (or zero to disable).
MeshMessageDeliveriesWeight, MeshMessageDeliveriesDecay float64 MeshMessageDeliveriesWeight, MeshMessageDeliveriesDecay float64
MeshMessageDeliveriesCap, MeshMessageDeliveriesThreshold float64 MeshMessageDeliveriesCap, MeshMessageDeliveriesThreshold float64
MeshMessageDeliveriesWindow, MeshMessageDeliveriesActivation time.Duration MeshMessageDeliveriesWindow, MeshMessageDeliveriesActivation time.Duration
@ -111,13 +111,13 @@ type TopicScoreParams struct {
// P3b: sticky mesh propagation failures // P3b: sticky mesh propagation failures
// This is a sticky penalty that applies when a peer gets pruned from the mesh with an active // This is a sticky penalty that applies when a peer gets pruned from the mesh with an active
// mesh message delivery penalty. // mesh message delivery penalty.
// The weight of the parameter MUST be negative (or zero if you want to disable it) // The weight of the parameter MUST be negative (or zero to disable)
MeshFailurePenaltyWeight, MeshFailurePenaltyDecay float64 MeshFailurePenaltyWeight, MeshFailurePenaltyDecay float64
// P4: invalid messages // P4: invalid messages
// This is the number of invalid messages in the topic. // This is the number of invalid messages in the topic.
// The value of the parameter is a counter, decaying with InvalidMessageDeliveriesDecay. // The value of the parameter is a counter, decaying with InvalidMessageDeliveriesDecay.
// The weight of the parameter MUST be negative. // The weight of the parameter MUST be negative (or zero to disable).
InvalidMessageDeliveriesWeight, InvalidMessageDeliveriesDecay float64 InvalidMessageDeliveriesWeight, InvalidMessageDeliveriesDecay float64
} }
@ -212,8 +212,8 @@ func (p *TopicScoreParams) validate() error {
} }
// check P4 // check P4
if p.InvalidMessageDeliveriesWeight >= 0 { if p.InvalidMessageDeliveriesWeight > 0 {
return fmt.Errorf("invalid InvalidMessageDeliveriesWeight; must be negative") return fmt.Errorf("invalid InvalidMessageDeliveriesWeight; must be negative (or 0 to disable)")
} }
if p.InvalidMessageDeliveriesDecay <= 0 || p.InvalidMessageDeliveriesDecay >= 1 { if p.InvalidMessageDeliveriesDecay <= 0 || p.InvalidMessageDeliveriesDecay >= 1 {
return fmt.Errorf("invalid InvalidMessageDeliveriesDecay; must be between 0 and 1") return fmt.Errorf("invalid InvalidMessageDeliveriesDecay; must be between 0 and 1")