throttler

Documentation

Index

• type Factory
  • func New(stats stats.Stats) (*Factory, error)
  • func (f *Factory) CheckLimitReached(context context.Context, workspaceId string) (bool, error)
• type Limiter
• type Throttler

Types

type Factory

type Factory struct {
	Stats stats.Stats
	// contains filtered or unexported fields
}

func New

func New(stats stats.Stats) (*Factory, error)

New constructs a new Throttler Factory

func (*Factory) CheckLimitReached

func (f *Factory) CheckLimitReached(context context.Context, workspaceId string) (bool, error)

type Limiter

type Limiter interface {
	// Allow returns true if the limit is not exceeded, false otherwise.
	Allow(ctx context.Context, cost, rate, window int64, key string) (bool, func(context.Context) error, error)
}

type Throttler

type Throttler interface {
	CheckLimitReached(context context.Context, workspaceId string) (bool, error)
}