limiter

package

v0.2.6 Latest Latest Go to latest Published: Jun 12, 2026 License: Apache-2.0 Imports: 13 Imported by: 1

Details

This section is empty.

This section is empty.

This section is empty.

type Blackbox interface {
	// contains filtered or unexported methods
}

type Client interface {
	Blackbox
	contract.LimiterOperator
}

func NewClient(d Dependencies, opts ClientOptions) (Client, error)

type ClientOption = contract.Opt[ClientOptions]

func WithGroup(x string) ClientOption

func WithLoaded(x Loaded) ClientOption

func WithMaxScore(x uint) ClientOption

func WithTimeout(x time.Duration) ClientOption

func WithWindow(x time.Duration) ClientOption

type ClientOptions struct {
	Loaded
	Group   string
	Timeout time.Duration
	Window  time.Duration
}

func ApplyClientOptions(opts *ClientOptions, modifiers ...ClientOption) ClientOptions

type DefaultTool struct {
	T *contract.Tool[Client]
}

func NewTool(c Client, opts contract.ToolOptions[Client]) *DefaultTool

func (d *DefaultTool) Engage(next contract.HandlerFunc) contract.HandlerFunc

Engage applies rate limiting to incoming HTTP requests.

func (d *DefaultTool) GetMaxScore(ctx context.Context) (uint, error)

GetMaxScore returns the maximum allowed request score.

type Dependencies struct {
	RC contract.RedisClient
}

type Loaded struct {
	MaxScore uint
}

type Tool interface {
	contract.LimiterOperator
}