throttling

Documentation

Index

• type DialThrottler
  • func NewDialThrottler(throttleLimit int) DialThrottler
  • func NewNoDialThrottler() DialThrottler
• type InboundMsgThrottler
  • func NewNoInboundThrottler() InboundMsgThrottler
  • func NewSybilInboundMsgThrottler(log logging.Logger, metricsRegisterer prometheus.Registerer, ...) (InboundMsgThrottler, error)
• type MsgThrottlerConfig
• type OutboundMsgThrottler
  • func NewNoOutboundThrottler() OutboundMsgThrottler
  • func NewSybilOutboundMsgThrottler(log logging.Logger, metricsRegisterer prometheus.Registerer, ...) (OutboundMsgThrottler, error)

Types

type DialThrottler

type DialThrottler interface {
	// Block until the event associated with this Acquire can happen.
	// If [ctx] is canceled, gives up and returns an error.
	Acquire(ctx context.Context) error
}

func NewDialThrottler

func NewDialThrottler(throttleLimit int) DialThrottler

func NewNoDialThrottler

func NewNoDialThrottler() DialThrottler

type InboundMsgThrottler

type InboundMsgThrottler interface {
	// Blocks until node [nodeID] can put a message of
	// size [msgSize] onto the incoming message buffer.
	Acquire(msgSize uint64, nodeID ids.ShortID)

	// Mark that a message from [nodeID] of size [msgSize]
	// has been removed from the incoming message buffer.
	Release(msgSize uint64, nodeID ids.ShortID)
}

InboundMsgThrottler rate-limits incoming messages from the network.

func NewNoInboundThrottler

func NewNoInboundThrottler() InboundMsgThrottler

func NewSybilInboundMsgThrottler

func NewSybilInboundMsgThrottler(
	log logging.Logger,
	metricsRegisterer prometheus.Registerer,
	vdrs validators.Set,
	config MsgThrottlerConfig,
) (InboundMsgThrottler, error)

Returns a new MsgThrottler. If this function returns an error, the returned MsgThrottler may still be used. However, some of its metrics may not be registered.

type MsgThrottlerConfig

type MsgThrottlerConfig struct {
	VdrAllocSize        uint64
	AtLargeAllocSize    uint64
	NodeMaxAtLargeBytes uint64
}

Used by the sybil-safe inbound and outbound message throttlers

type OutboundMsgThrottler

type OutboundMsgThrottler interface {
	// Returns true if we can queue a message of size [msgSize] to be sent to node [nodeID].
	// Returns false if the message should be dropped (not sent to [nodeID]).
	// If this method returns true, Release([msgSize], [nodeID]) must be called (!) when
	// the message is sent (or when we give up trying to send the message, if applicable.)
	// If this method returns false, do not make a corresponding call to Release.
	Acquire(msgSize uint64, nodeID ids.ShortID) bool

	// Mark that a message of size [msgSize] has been sent to [nodeID] or we have
	// given up sending the message. Must correspond to a previous call to
	// Acquire([msgSize], [nodeID]) that returned true.
	Release(msgSize uint64, nodeID ids.ShortID)
}

Rate-limits outgoing messages

func NewNoOutboundThrottler

func NewNoOutboundThrottler() OutboundMsgThrottler

func NewSybilOutboundMsgThrottler

func NewSybilOutboundMsgThrottler(
	log logging.Logger,
	metricsRegisterer prometheus.Registerer,
	vdrs validators.Set,
	config MsgThrottlerConfig,
) (OutboundMsgThrottler, error)