ratelimiter

Documentation

Index

• Constants
• func DecorateConsumer[T any](limiter RateLimiter, fn func(T) error) func(T) error
• func DecorateFunction[T any, R any](limiter RateLimiter, fn func(T) (R, error)) func(T) (R, error)
• func DecorateRunnable(limiter RateLimiter, fn func() error) func() error
• func DecorateSupplier[T any](limiter RateLimiter, fn func() (T, error)) func() (T, error)
• type Config
  • func (config *Config) String() string
• type ConfigBuilder
  • func WithLimitForPeriod(limitForPeriod int64) ConfigBuilder
  • func WithLimitRefreshPeriod(limitRefreshPeriod time.Duration) ConfigBuilder
  • func WithTimeoutDuration(timeoutDuration time.Duration) ConfigBuilder
• type Event
• type EventListener
• type EventType
• type FailureEvent
• type Metrics
• type NotPermittedError
  • func (e *NotPermittedError) Error() string
• type RateLimiter
  • func NewRateLimiter(name string, configs ...ConfigBuilder) RateLimiter
• type SuccessEvent

Constants

const DefaultLimitForPeriod int64 = 50

const DefaultLimitRefreshPeriod = time.Nanosecond * 500

const DefaultTimeoutDuration = time.Second * 5

Functions

func DecorateConsumer

func DecorateConsumer[T any](limiter RateLimiter, fn func(T) error) func(T) error

func DecorateFunction

func DecorateFunction[T any, R any](limiter RateLimiter, fn func(T) (R, error)) func(T) (R, error)

func DecorateRunnable

func DecorateRunnable(limiter RateLimiter, fn func() error) func() error

func DecorateSupplier

func DecorateSupplier[T any](limiter RateLimiter, fn func() (T, error)) func() (T, error)

Types

type Config

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

func (*Config) String

func (config *Config) String() string

type ConfigBuilder

type ConfigBuilder func(*Config)

func WithLimitForPeriod

func WithLimitForPeriod(limitForPeriod int64) ConfigBuilder

func WithLimitRefreshPeriod

func WithLimitRefreshPeriod(limitRefreshPeriod time.Duration) ConfigBuilder

func WithTimeoutDuration

func WithTimeoutDuration(timeoutDuration time.Duration) ConfigBuilder

type Event

type Event interface {
	fmt.Stringer
	RateLimiterName() string
	CreationTime() time.Time
	EventType() EventType
}

type EventListener

type EventListener interface {
	OnSuccessFunc(func(SuccessEvent)) EventListener
	OnFailureFunc(func(FailureEvent)) EventListener
	DismissSuccessFunc(func(SuccessEvent)) EventListener
	DismissFailureFunc(func(FailureEvent)) EventListener

	OnSuccess(fn.Consumer[SuccessEvent]) EventListener
	OnFailure(fn.Consumer[FailureEvent]) EventListener
	DismissSuccess(fn.Consumer[SuccessEvent]) EventListener
	DismissFailure(fn.Consumer[FailureEvent]) EventListener
}

type EventType

type EventType string

const (
	SUCCESSFUL EventType = "SUCCESSFUL_ACQUIRE"
	FAILED     EventType = "FAILED_ACQUIRE"
)

type FailureEvent

type FailureEvent interface {
	Event
}

type Metrics

type Metrics interface {
	NumberOfWaitingThreads() int64
	AvailablePermissions() int64
}

type NotPermittedError

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

func (*NotPermittedError) Error

func (e *NotPermittedError) Error() string

type RateLimiter

type RateLimiter interface {
	Name() string
	Metrics() Metrics
	EventListener() EventListener
	AcquirePermission() error
}

func NewRateLimiter

func NewRateLimiter(name string, configs ...ConfigBuilder) RateLimiter

type SuccessEvent

type SuccessEvent interface {
	Event
}