plugin

Documentation

Index

• Constants
• func Verify(params, returnVal *structpb.Struct) bool
• type HookConfig
  • func NewHookConfig() *HookConfig
  • func (h *HookConfig) Add(hookType HookType, prio Priority, hook HookDef)
  • func (h *HookConfig) Get(hookType HookType) map[Priority]HookDef
  • func (h *HookConfig) Hooks() map[HookType]map[Priority]HookDef
  • func (h *HookConfig) Run(ctx context.Context, args *structpb.Struct, hookType HookType, ...) (*structpb.Struct, error)
• type HookDef
• type HookType
• type Identifier
• type Impl
  • func (p *Impl) Dispense() (pluginV1.GatewayDPluginServiceClient, error)
  • func (p *Impl) Start() (net.Addr, error)
  • func (p *Impl) Stop()
• type Plugin
• type Policy
• type Priority
• type Registry
• type RegistryImpl
  • func NewRegistry(hooksConfig *HookConfig) *RegistryImpl
  • func (reg *RegistryImpl) Add(plugin *Impl) bool
  • func (reg *RegistryImpl) Get(id Identifier) *Impl
  • func (reg *RegistryImpl) List() []Identifier
  • func (reg *RegistryImpl) LoadPlugins(pluginConfig *koanf.Koanf)
  • func (reg *RegistryImpl) RegisterHooks(id Identifier)
  • func (reg *RegistryImpl) Remove(id Identifier)
  • func (reg *RegistryImpl) Shutdown()

Constants

const (
	DefaultMinPort      uint = 50000
	DefaultMaxPort      uint = 60000
	PluginPriorityStart uint = 1000
)

Functions

func Verify

func Verify(params, returnVal *structpb.Struct) bool

Verify compares two structs and returns true if they are equal.

Types

type HookConfig

type HookConfig struct {
	Logger       zerolog.Logger
	Verification Policy
	// contains filtered or unexported fields
}

func NewHookConfig

func NewHookConfig() *HookConfig

func (*HookConfig) Add

func (h *HookConfig) Add(hookType HookType, prio Priority, hook HookDef)

func (*HookConfig) Get

func (h *HookConfig) Get(hookType HookType) map[Priority]HookDef

func (*HookConfig) Hooks

func (h *HookConfig) Hooks() map[HookType]map[Priority]HookDef

func (*HookConfig) Run

func (h *HookConfig) Run(
	ctx context.Context,
	args *structpb.Struct,
	hookType HookType,
	verification Policy,
	opts ...grpc.CallOption,
) (*structpb.Struct, error)

type HookDef

type HookDef func(
	context.Context, *structpb.Struct, ...grpc.CallOption) (*structpb.Struct, error)

type HookType

type HookType string

const (
	// Run command hooks (cmd/run.go).
	OnConfigLoaded HookType = "onConfigLoaded"
	OnNewLogger    HookType = "onNewLogger"
	OnNewPool      HookType = "onNewPool"
	OnNewProxy     HookType = "onNewProxy"
	OnNewServer    HookType = "onNewServer"
	OnSignal       HookType = "onSignal"
	// Server hooks (network/server.go).
	OnRun            HookType = "onRun"
	OnBooting        HookType = "onBooting"
	OnBooted         HookType = "onBooted"
	OnOpening        HookType = "onOpening"
	OnOpened         HookType = "onOpened"
	OnClosing        HookType = "onClosing"
	OnClosed         HookType = "onClosed"
	OnTraffic        HookType = "onTraffic"
	OnIngressTraffic HookType = "onIngressTraffic"
	OnEgressTraffic  HookType = "onEgressTraffic"
	OnShutdown       HookType = "onShutdown"
	OnTick           HookType = "onTick"
	// Pool hooks (network/pool.go).
	OnNewClient HookType = "onNewClient"
)

type Identifier

type Identifier struct {
	Name      string
	Version   string
	RemoteURL string
	Checksum  string
}

type Impl

type Impl struct {
	goplugin.NetRPCUnsupportedPlugin
	pluginV1.GatewayDPluginServiceServer

	ID          Identifier
	Description string
	Authors     []string
	License     string
	ProjectURL  string
	LocalPath   string
	Enabled     bool
	// internal and external config options
	Config map[string]string
	// hooks it attaches to
	Hooks    []HookType
	Priority Priority
	// required plugins to be loaded before this one
	// Built-in plugins are always loaded first
	Requires   []Identifier
	Tags       []string
	Categories []string
	// contains filtered or unexported fields
}

func (*Impl) Dispense

func (p *Impl) Dispense() (pluginV1.GatewayDPluginServiceClient, error)

func (*Impl) Start

func (p *Impl) Start() (net.Addr, error)

func (*Impl) Stop

func (p *Impl) Stop()

type Plugin

type Plugin interface {
	Start() (net.Addr, error)
	Stop()
	Dispense() (pluginV1.GatewayDPluginServiceClient, error)
}

type Policy

type Policy int

const (
	// Non-strict (permissive) mode.
	PassDown Policy = iota // Pass down the extra keys/values in result to the next plugins
	// Strict mode.
	Ignore // Ignore errors and continue
	Abort  // Abort on first error and return results
	Remove // Remove the hook from the list on error and continue
)

type Priority

type Priority uint

Priority is the priority of a hook. Smaller values are executed first (higher priority).

type Registry

type Registry interface {
	Add(plugin *Impl) bool
	Get(id Identifier) *Impl
	List() []Identifier
	Remove(id Identifier)
	Shutdown()
	LoadPlugins(pluginConfig *koanf.Koanf)
	RegisterHooks(id Identifier)
}

type RegistryImpl

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

func NewRegistry

func NewRegistry(hooksConfig *HookConfig) *RegistryImpl

func (*RegistryImpl) Add

func (reg *RegistryImpl) Add(plugin *Impl) bool

func (*RegistryImpl) Get

func (reg *RegistryImpl) Get(id Identifier) *Impl

func (*RegistryImpl) List

func (reg *RegistryImpl) List() []Identifier

func (*RegistryImpl) LoadPlugins

func (reg *RegistryImpl) LoadPlugins(pluginConfig *koanf.Koanf)

func (*RegistryImpl) RegisterHooks

func (reg *RegistryImpl) RegisterHooks(id Identifier)

func (*RegistryImpl) Remove

func (reg *RegistryImpl) Remove(id Identifier)

func (*RegistryImpl) Shutdown

func (reg *RegistryImpl) Shutdown()