handler

Documentation

Index

• Constants
• func GetPluginTypes() []string
• func InitAndRegPlugin(c *Config) (err error)
• func NewErrFromTemplate(t ErrTemplate, args ...interface{}) error
• func PurgePluginRegister()
• func RegInitFunc(pluginType string, initFunc NewPluginFunc)
• func RegPlugin(p Plugin) error
• func Walk(ctx context.Context, qCtx *Context, entryTag string) (err error)
• type Args
  • func (a Args) WeakDecode(output interface{}) error
• type Config
• type Context
  • func (ctx *Context) Copy() *Context
  • func (ctx *Context) Logf(level logrus.Level, format string, args ...interface{})
  • func (ctx *Context) String() string
• type DummyFunctional
  • func (d *DummyFunctional) Do(_ context.Context, _ *Context) (err error)
• type DummyMatcher
  • func (d *DummyMatcher) Match(_ context.Context, _ *Context) (matched bool, err error)
• type DummyRouterPlugin
  • func (d *DummyRouterPlugin) Do(_ context.Context, _ *Context) (next string, err error)
  • func (d *DummyRouterPlugin) Tag() string
  • func (d *DummyRouterPlugin) Type() string
• type ErrTemplate
• type Error
  • func (e *Error) Error() string
• type Functional
• type FunctionalPlugin
  • func GetFunctionalPlugin(tag string) (p FunctionalPlugin, ok bool)
• type FunctionalPluginWrapper
  • func WrapFunctionalPlugin(tag, typ string, functional Functional) *FunctionalPluginWrapper
  • func (p *FunctionalPluginWrapper) Tag() string
  • func (p *FunctionalPluginWrapper) Type() string
• type Matcher
• type MatcherPlugin
  • func GetMatcherPlugin(tag string) (p MatcherPlugin, ok bool)
• type MatcherPluginWrapper
  • func WrapMatcherPlugin(tag, typ string, matcher Matcher) *MatcherPluginWrapper
  • func (c *MatcherPluginWrapper) Tag() string
  • func (c *MatcherPluginWrapper) Type() string
• type NewPluginFunc
• type Plugin
  • func GetPlugin(tag string) (p Plugin, ok bool)
  • func NewPlugin(c *Config) (p Plugin, err error)
• type RouterPlugin
  • func GetRouterPlugin(tag string) (p RouterPlugin, ok bool)

Constants

const (
	ETInvalidArgs    = "invalid args: %w"
	ETPluginErr      = "plugin %s reported an err: %w"
	ETTypeNotDefined = "plugin type %s not not defined"
	ETTagNotDefined  = "plugin tag %s not not defined"
)

const (
	// IterationLimit is to prevent endless loops.
	IterationLimit = 50

	// StopSignTag: See Walk().
	StopSignTag = "end"
)

Functions

func GetPluginTypes

func GetPluginTypes() []string

GetPluginTypes returns all registered plugin types.

func InitAndRegPlugin

func InitAndRegPlugin(c *Config) (err error)

InitAndRegPlugin inits and registers this plugin globally. Duplicate plugin tags are not allowed.

func NewErrFromTemplate

func NewErrFromTemplate(t ErrTemplate, args ...interface{}) error

func PurgePluginRegister

func PurgePluginRegister()

PurgePluginRegister should only be used in test.

func RegInitFunc

func RegInitFunc(pluginType string, initFunc NewPluginFunc)

RegInitFunc registers this plugin type. This should only be called in init() of the plugin package. Duplicate plugin types are not allowed.

func RegPlugin

func RegPlugin(p Plugin) error

RegPlugin registers this Plugin globally. Duplicate Plugin tag will be overwritten. Plugin must be a FunctionalPlugin, MatcherPlugin or RouterPlugin.

func Walk

func Walk(ctx context.Context, qCtx *Context, entryTag string) (err error)

Walk walks into this RouterPlugin. Walk will stop and return when last RouterPlugin.Do() returns: 1. An empty tag or StopSignTag. 2. An error.

Types

type Args

type Args map[string]interface{}

Args contains plugin arguments.

func (Args) WeakDecode

func (a Args) WeakDecode(output interface{}) error

type Config

type Config struct {
	// Tag, required
	Tag string `yaml:"tag"`

	// Type, required
	Type string `yaml:"type"`

	// Args, might be required by some plugins
	Args Args `yaml:"args"`
}

type Context

type Context struct {
	Q    *dns.Msg
	From net.Addr

	R *dns.Msg
}

func (*Context) Copy

func (ctx *Context) Copy() *Context

func (*Context) Logf

func (ctx *Context) Logf(level logrus.Level, format string, args ...interface{})

func (*Context) String

func (ctx *Context) String() string

type DummyFunctional

type DummyFunctional struct {
	WantErr error
}

func (*DummyFunctional) Do

func (d *DummyFunctional) Do(_ context.Context, _ *Context) (err error)

type DummyMatcher

type DummyMatcher struct {
	Matched bool
	WantErr error
}

func (*DummyMatcher) Match

func (d *DummyMatcher) Match(_ context.Context, _ *Context) (matched bool, err error)

type DummyRouterPlugin

type DummyRouterPlugin struct {
	TagStr   string
	WantNext string
	WantErr  error
}

func (*DummyRouterPlugin) Do

func (d *DummyRouterPlugin) Do(_ context.Context, _ *Context) (next string, err error)

func (*DummyRouterPlugin) Tag

func (d *DummyRouterPlugin) Tag() string

func (*DummyRouterPlugin) Type

func (d *DummyRouterPlugin) Type() string

type ErrTemplate

type ErrTemplate string

type Error

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

func (*Error) Error

func (e *Error) Error() string

type Functional

type Functional interface {
	Do(ctx context.Context, qCtx *Context) (err error)
}

type FunctionalPlugin

type FunctionalPlugin interface {
	Plugin
	Functional
}

func GetFunctionalPlugin

func GetFunctionalPlugin(tag string) (p FunctionalPlugin, ok bool)

type FunctionalPluginWrapper

type FunctionalPluginWrapper struct {
	Functional
	// contains filtered or unexported fields
}

func WrapFunctionalPlugin

func WrapFunctionalPlugin(tag, typ string, functional Functional) *FunctionalPluginWrapper

WrapFunctionalPlugin returns a *FunctionalPluginWrapper which implements Plugin and FunctionalPlugin.

func (*FunctionalPluginWrapper) Tag

func (p *FunctionalPluginWrapper) Tag() string

func (*FunctionalPluginWrapper) Type

func (p *FunctionalPluginWrapper) Type() string

type Matcher

type Matcher interface {
	Match(ctx context.Context, qCtx *Context) (matched bool, err error)
}

type MatcherPlugin

type MatcherPlugin interface {
	Plugin
	Matcher
}

func GetMatcherPlugin

func GetMatcherPlugin(tag string) (p MatcherPlugin, ok bool)

type MatcherPluginWrapper

type MatcherPluginWrapper struct {
	Matcher
	// contains filtered or unexported fields
}

func WrapMatcherPlugin

func WrapMatcherPlugin(tag, typ string, matcher Matcher) *MatcherPluginWrapper

WrapMatcherPlugin returns a *MatcherPluginWrapper which implements Plugin and MatcherPlugin.

func (*MatcherPluginWrapper) Tag

func (c *MatcherPluginWrapper) Tag() string

func (*MatcherPluginWrapper) Type

func (c *MatcherPluginWrapper) Type() string

type NewPluginFunc

type NewPluginFunc func(tag string, args Args) (p Plugin, err error)

type Plugin

type Plugin interface {
	Tag() string
	Type() string
}

func GetPlugin

func GetPlugin(tag string) (p Plugin, ok bool)

func NewPlugin

func NewPlugin(c *Config) (p Plugin, err error)

type RouterPlugin

type RouterPlugin interface {
	Plugin
	Do(ctx context.Context, qCtx *Context) (next string, err error)
}

func GetRouterPlugin

func GetRouterPlugin(tag string) (p RouterPlugin, ok bool)