flowcontrol

Documentation

Index

• func Module() fx.Option
• func NewEngine(agentInfo *agentinfo.AgentInfo) iface.Engine
• type Engine
  • func (e *Engine) GetAgentInfo() *agentinfo.AgentInfo
  • func (e *Engine) GetFluxMeter(fluxMeterName string) iface.FluxMeter
  • func (e *Engine) GetRateLimiter(limiterID iface.LimiterID) iface.RateLimiter
  • func (e *Engine) GetRegulator(limiterID iface.LimiterID) iface.Limiter
  • func (e *Engine) GetScheduler(limiterID iface.LimiterID) iface.Scheduler
  • func (e *Engine) ProcessRequest(ctx context.Context, requestContext iface.RequestContext) (response *flowcontrolv1.CheckResponse)
  • 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) RegisterRegulator(l iface.Limiter) error
  • func (e *Engine) RegisterScheduler(cl iface.Scheduler) 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
  • func (e *Engine) UnregisterRegulator(rl iface.Limiter) error
  • func (e *Engine) UnregisterScheduler(cl iface.Scheduler) error

Functions

func Module

func Module() fx.Option

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

func NewEngine

func NewEngine(agentInfo *agentinfo.AgentInfo) 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) GetAgentInfo

func (e *Engine) GetAgentInfo() *agentinfo.AgentInfo

GetAgentInfo returns the agent info.

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) GetRegulator

func (e *Engine) GetRegulator(limiterID iface.LimiterID) iface.Limiter

GetRegulator Lookup function for getting regulator.

func (*Engine) GetScheduler

func (e *Engine) GetScheduler(limiterID iface.LimiterID) iface.Scheduler

GetScheduler Lookup function for getting scheduler.

func (*Engine) ProcessRequest

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

ProcessRequest .

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) RegisterRegulator

func (e *Engine) RegisterRegulator(l iface.Limiter) error

RegisterRegulator adds limiter actuator to multimatcher.

func (*Engine) RegisterScheduler

func (e *Engine) RegisterScheduler(cl iface.Scheduler) error

RegisterScheduler adds scheduler to 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.

func (*Engine) UnregisterRegulator

func (e *Engine) UnregisterRegulator(rl iface.Limiter) error

UnregisterRegulator removes limiter actuator from multimatcher.

func (*Engine) UnregisterScheduler

func (e *Engine) UnregisterScheduler(cl iface.Scheduler) error

UnregisterScheduler removes scheduler from multimatcher.