floodPreventers

Documentation

Index

• Constants
• func NewQuotaFloodPreventer(arg ArgQuotaFloodPreventer) (*quotaFloodPreventer, error)
• func NewTopicFloodPreventer(maxMessagesPerPeer uint32) (*topicFloodPreventer, error)
• type ArgQuotaFloodPreventer
• type QuotaStatusHandler

Constants

const WildcardCharacter = "*"

WildcardCharacter is the character string used to specify that the topic refers to a

Functions

func NewQuotaFloodPreventer

func NewQuotaFloodPreventer(arg ArgQuotaFloodPreventer) (*quotaFloodPreventer, error)

NewQuotaFloodPreventer creates a new flood preventer based on quota / peer

func NewTopicFloodPreventer

func NewTopicFloodPreventer(
	maxMessagesPerPeer uint32,
) (*topicFloodPreventer, error)

NewTopicFloodPreventer creates a new flood preventer based on topic

Types

type ArgQuotaFloodPreventer

type ArgQuotaFloodPreventer struct {
	Name                      string
	Cacher                    storage.Cacher
	StatusHandlers            []QuotaStatusHandler
	MaxTotalSizePerPeer       uint64
	PercentReserved           float32
	IncreaseFactor            float32
	IncreaseThreshold         uint32
	BaseMaxNumMessagesPerPeer uint32
}

ArgQuotaFloodPreventer defines the arguments for a quota flood preventer

type QuotaStatusHandler

type QuotaStatusHandler interface {
	ResetStatistics()
	AddQuota(pid core.PeerID, numReceived uint32, sizeReceived uint64, numProcessed uint32, sizeProcessed uint64)
	IsInterfaceNil() bool
}

QuotaStatusHandler defines the behavior of a quota handler able to process periodic updates of peers quota measured by the system