runtime

Documentation

Index

• func NewFramework(registry Registry, handle framework.Handle, ...) (framework.Framework, error)
• type PluginFactory
• type Registry
  • func (r Registry) Merge(in Registry) error
  • func (r Registry) Register(name string, factory PluginFactory) error
  • func (r Registry) Unregister(name string) error

Functions

func NewFramework

func NewFramework(registry Registry, handle framework.Handle, enabledPlugins *fedcore.EnabledPlugins,
	profileName string, metrics stats.Metrics,
) (framework.Framework, error)

Types

type PluginFactory

type PluginFactory = func(f framework.Handle) (framework.Plugin, error)

PluginFactory is a function that builds a plugin.

type Registry

type Registry map[string]PluginFactory

Registry is a collection of all available plugins. The framework uses a registry to enable and initialize configured plugins. All plugins must be in the registry before initializing the framework.

func (Registry) Merge

func (r Registry) Merge(in Registry) error

Merge merges the provided registry to the current one.

func (Registry) Register

func (r Registry) Register(name string, factory PluginFactory) error

func (Registry) Unregister

func (r Registry) Unregister(name string) error

Unregister removes an existing plugin from the registry. If no plugin with the provided name exists, it returns an error.