rules

Documentation

Index

• Variables
• type Repository
  • func NewRepository(queue event.RuleSetChangedEventQueue, ruleFactory RuleFactory, ...) (Repository, error)
• type RuleFactory
  • func NewRuleFactory(hf mechanisms.Factory, conf *config.Configuration, logger zerolog.Logger) (RuleFactory, error)

Variables

var Module = fx.Options(
	fx.Provide(func(logger zerolog.Logger) event.RuleSetChangedEventQueue {
		logger.Debug().Msg("Creating rule set event queue.")

		return make(event.RuleSetChangedEventQueue, defaultQueueSize)
	}),
	fx.Provide(NewRepository, NewRuleFactory),
	fx.Invoke(registerRuleDefinitionHandler, registerRuleSetChangedEventQueueCloser),
	provider.Module,
)

Module is invoked on app bootstrapping. nolint: gochecknoglobals

Types

type Repository

type Repository interface {
	FindRule(*url.URL) (rule.Rule, error)
}

func NewRepository

func NewRepository(
	queue event.RuleSetChangedEventQueue,
	ruleFactory RuleFactory,
	logger zerolog.Logger,
) (Repository, error)

type RuleFactory

type RuleFactory interface {
	CreateRule(srcID string, ruleConfig rule.Configuration) (rule.Rule, error)
	HasDefaultRule() bool
	DefaultRule() rule.Rule
}

func NewRuleFactory

func NewRuleFactory(hf mechanisms.Factory, conf *config.Configuration, logger zerolog.Logger) (
	RuleFactory, error,
)