Lux Docs

throttling

Package throttling

import "github.com/luxfi/node/network/throttling"

Functions

NewThrottledListener

func NewThrottledListener(listener net.Listener, maxConnsPerSec float64) net.Listener

Wraps [listener] and returns a net.Listener that will accept at most [maxConnsPerSec] connections per second. [maxConnsPerSec] must be non-negative.

Types

DialThrottler

func NewDialThrottler(throttleLimit int) DialThrottler

func NewNoDialThrottler() DialThrottler

InboundConnUpgradeThrottler returns whether we should upgrade an inbound connection from IP [ipStr]. If ShouldUpgrade(ipStr) returns false, the connection to that IP should be closed. Note that InboundConnUpgradeThrottler rate-limits upgrading of inbound connections, whereas throttledListener rate-limits acceptance of inbound connections.

func NewInboundConnUpgradeThrottler(config InboundConnUpgradeThrottlerConfig) InboundConnUpgradeThrottler

InboundConnUpgradeThrottlerConfig

InboundMsgThrottler

InboundMsgThrottler rate-limits inbound messages from the network.

func NewInboundMsgThrottler(
	log log.Logger,
	registerer metric.Registerer,
	vdrs validators.Manager,
	throttlerConfig InboundMsgThrottlerConfig,
	resourceTracker tracker.ResourceTracker,
	cpuTargeter tracker.Targeter,
	diskTargeter tracker.Targeter,
) (InboundMsgThrottler, error)

func NewNoInboundThrottler() InboundMsgThrottler

InboundMsgThrottlerConfig

MsgByteThrottlerConfig

Used by the sybil-safe inbound and outbound message throttlers

OutboundMsgThrottler

Rate-limits outgoing messages

func NewNoOutboundThrottler() OutboundMsgThrottler

func NewSybilOutboundMsgThrottler(
	log log.Logger,
	registerer metric.Registerer,
	vdrs validators.Manager,
	config MsgByteThrottlerConfig,
) (OutboundMsgThrottler, error)

ReleaseFunc

SystemThrottler

SystemThrottler rate-limits based on the system metrics usage caused by each peer. We will not read messages from peers whose messages cause excessive usage until the usage caused by the peer drops to an acceptable level.

func NewSystemThrottler(
	namespace string,
	reg metric.Registerer,
	config SystemThrottlerConfig,
	tracker tracker.Tracker,
	targeter tracker.Targeter,
) (SystemThrottler, error)