flowcontrol

Documentation

Index

• func Module() fx.Option
• func NewEngine() iface.Engine
• type Engine
  • func (e *Engine) GetConcurrencyLimiter(limiterID iface.LimiterID) iface.ConcurrencyLimiter
  • func (e *Engine) GetFluxMeter(fluxMeterName string) iface.FluxMeter
  • func (e *Engine) GetRateLimiter(limiterID iface.LimiterID) iface.RateLimiter
  • func (e *Engine) ProcessRequest(ctx context.Context, requestContext iface.RequestContext) (response *flowcontrolv1.CheckResponse)
  • func (e *Engine) RegisterConcurrencyLimiter(cl iface.ConcurrencyLimiter) error
  • func (e *Engine) RegisterFluxMeter(fm iface.FluxMeter) error
  • func (e *Engine) RegisterLabelPreview(lp iface.LabelPreview) error
  • func (e *Engine) RegisterRateLimiter(rl iface.RateLimiter) error
  • func (e *Engine) UnregisterConcurrencyLimiter(cl iface.ConcurrencyLimiter) error
  • func (e *Engine) UnregisterFluxMeter(fm iface.FluxMeter) error
  • func (e *Engine) UnregisterLabelPreview(lp iface.LabelPreview) error
  • func (e *Engine) UnregisterRateLimiter(rl iface.RateLimiter) error

Functions

func Module

func Module() fx.Option

Module returns the fx options for dataplane side pieces of policy.

func NewEngine

func NewEngine() iface.Engine

NewEngine Main fx app.

Types

type Engine

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

Engine APIs to (1) Get schedulers given a service, control point and set of labels. (2) Get flux meter histogram given a metric id.

func (*Engine) GetConcurrencyLimiter

func (e *Engine) GetConcurrencyLimiter(limiterID iface.LimiterID) iface.ConcurrencyLimiter

GetConcurrencyLimiter Lookup function for getting concurrency limiter.

func (*Engine) GetFluxMeter

func (e *Engine) GetFluxMeter(fluxMeterName string) iface.FluxMeter

GetFluxMeter Lookup function for getting flux meter.

func (*Engine) GetRateLimiter

func (e *Engine) GetRateLimiter(limiterID iface.LimiterID) iface.RateLimiter

GetRateLimiter Lookup function for getting rate limiter.

func (*Engine) ProcessRequest

func (e *Engine) ProcessRequest(
	ctx context.Context,
	requestContext iface.RequestContext,
) (response *flowcontrolv1.CheckResponse)

ProcessRequest .

func (*Engine) RegisterConcurrencyLimiter

func (e *Engine) RegisterConcurrencyLimiter(cl iface.ConcurrencyLimiter) error

RegisterConcurrencyLimiter adds concurrency limiter to multimatcher.

func (*Engine) RegisterFluxMeter

func (e *Engine) RegisterFluxMeter(fm iface.FluxMeter) error

RegisterFluxMeter adds fluxmeter to histogram map and multimatcher.

func (*Engine) RegisterLabelPreview

func (e *Engine) RegisterLabelPreview(lp iface.LabelPreview) error

RegisterLabelPreview adds label preview to multimatcher.

func (*Engine) RegisterRateLimiter

func (e *Engine) RegisterRateLimiter(rl iface.RateLimiter) error

RegisterRateLimiter adds limiter actuator to multimatcher.

func (*Engine) UnregisterConcurrencyLimiter

func (e *Engine) UnregisterConcurrencyLimiter(cl iface.ConcurrencyLimiter) error

UnregisterConcurrencyLimiter removes concurrency limiter from multimatcher.

func (*Engine) UnregisterFluxMeter

func (e *Engine) UnregisterFluxMeter(fm iface.FluxMeter) error

UnregisterFluxMeter removes fluxmeter from histogram map and multimatcher.

func (*Engine) UnregisterLabelPreview

func (e *Engine) UnregisterLabelPreview(lp iface.LabelPreview) error

UnregisterLabelPreview removes label preview from multimatcher.

func (*Engine) UnregisterRateLimiter

func (e *Engine) UnregisterRateLimiter(rl iface.RateLimiter) error

UnregisterRateLimiter removes limiter actuator from multimatcher.