plugin

Documentation

Index

• func NewGrpcPlugin(name string, address string) *grpcPlugin
• func NewInternalPlugin(name string, logger log.Logger) *internalPlugin
• type BasePlugin
  • func (p *BasePlugin) GetName() string
• type EventHandlerPlugin
• type Manager
  • func NewManager(logger log.Logger, errorHandler emperror.Handler) *Manager
  • func (m *Manager) Add(plugins ...EventHandlerPlugin)
  • func (m *Manager) GetByName(name string) (EventHandlerPlugin, error)
  • func (m *Manager) GetByNames(names ...string) (map[string]EventHandlerPlugin, error)
  • func (m *Manager) LoadFromConfig(v *viper.Viper) error
• type PluginConfig
  • func (c PluginConfig) Validate() error
• type PluginConfigs
• type PluginManager

Functions

func NewGrpcPlugin

func NewGrpcPlugin(name string, address string) *grpcPlugin

NewGrpcPlugin initializes a grpcPlugin

func NewInternalPlugin

func NewInternalPlugin(name string, logger log.Logger) *internalPlugin

NewInternalPlugin returns an initialized internalPlugin

Types

type BasePlugin

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

BasePlugin describes a basic plugin struct

func (*BasePlugin) GetName

func (p *BasePlugin) GetName() string

GetName returns the plugin name

type EventHandlerPlugin

type EventHandlerPlugin interface {
	GetName() string
	Handle(event *ce.Event) error
}

EventHandlerPlugin defines an event handler plugin

type Manager

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

Manager is a PluginManager implementation

func NewManager

func NewManager(logger log.Logger, errorHandler emperror.Handler) *Manager

NewManager returns an initialized Manager

func (*Manager) Add

func (m *Manager) Add(plugins ...EventHandlerPlugin)

Add add an initialized plugin

func (*Manager) GetByName

func (m *Manager) GetByName(name string) (EventHandlerPlugin, error)

GetByName returns a plugin by it's name

func (*Manager) GetByNames

func (m *Manager) GetByNames(names ...string) (map[string]EventHandlerPlugin, error)

GetByNames returns a map of plugins by their names

func (*Manager) LoadFromConfig

func (m *Manager) LoadFromConfig(v *viper.Viper) error

LoadFromConfig loads plugins from configuration

type PluginConfig

type PluginConfig struct {
	Name    string `mapstructure:"name"`
	Type    string `mapstructure:"type"`
	Address string `mapstructure:"address"`
}

PluginConfig describes a plugin configuration

func (PluginConfig) Validate

func (c PluginConfig) Validate() error

Validate validates plugin configuration

type PluginConfigs

type PluginConfigs []PluginConfig

type PluginManager

type PluginManager interface {
	Add(plugin ...EventHandlerPlugin)
	GetByNames(names ...string) (map[string]EventHandlerPlugin, error)
	GetByName(name string) (EventHandlerPlugin, error)
}

PluginManager describes what a plugin manager implementation must provide