ratelimit

package

v0.11.1 Latest Latest Go to latest Published: Mar 24, 2026 License: MIT Imports: 3 Imported by: 11

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/smartcontractkit/chainlink-common

Links

Open Source Insights

Documentation ¶

Index ¶

type RateLimiter
- func NewRateLimiter(config RateLimiterConfig) (*RateLimiter, error)
type RateLimiterConfig

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type RateLimiter ¶

type RateLimiter struct {
	// contains filtered or unexported fields
}

Wrapper around Go's rate.Limiter that supports both global and a per-sender rate limiting.

func NewRateLimiter ¶

func NewRateLimiter(config RateLimiterConfig) (*RateLimiter, error)

func (*RateLimiter) Allow ¶

func (rl *RateLimiter) Allow(sender string) bool

Allow checks that the sender is not rate limited, and that there is not a global rate limit.

func (*RateLimiter) AllowVerbose ¶

func (rl *RateLimiter) AllowVerbose(sender string) (senderAllow bool, globalAllow bool)

Allow checks that the sender is not rate limited, and that there is not a global rate limit. Returns if allowed as separate outputs.

func (*RateLimiter) SetConfig ¶ added in v0.9.7

func (rl *RateLimiter) SetConfig(config RateLimiterConfig)

type RateLimiterConfig ¶

type RateLimiterConfig struct {
	GlobalRPS      float64 `json:"globalRPS"`
	GlobalBurst    int     `json:"globalBurst"`
	PerSenderRPS   float64 `json:"perSenderRPS"`
	PerSenderBurst int     `json:"perSenderBurst"`
}

Source Files ¶

View all Source files

ratelimiter.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL