config

type RateLimit struct {
	FullKey string
	Stats   RateLimitStats
	Limit   *pb.RateLimitResponse_RateLimit
}

type RateLimitConfig interface {
	// Dump the configuration into string form for debugging.
	Dump() string

	// Get the configured limit for a rate limit descriptor.
	// @param ctx supplies the calling context.
	// @param domain supplies the domain to lookup the descriptor in.
	// @param descriptor supplies the descriptor to look up.
	// @return a rate limit to apply or nil if no rate limit is configured for the descriptor.
	GetLimit(ctx context.Context, domain string, descriptor *pb_struct.RateLimitDescriptor) *RateLimit
}

type RateLimitConfigError string

type RateLimitConfigLoader interface {
	// Load a new configuration from a list of YAML files.
	// @param configs supplies a list of full YAML files in string form.
	// @param statsScope supplies the stats scope to use for limit stats during runtime.
	// @return a new configuration.
	// @throws RateLimitConfigError if the configuration could not be created.
	Load(configs []RateLimitConfigToLoad, statsScope stats.Scope) RateLimitConfig
}

type RateLimitConfigToLoad struct {
	Name      string
	FileBytes string
}

type RateLimitStats struct {
	TotalHits               stats.Counter
	OverLimit               stats.Counter
	NearLimit               stats.Counter
	OverLimitWithLocalCache stats.Counter
}