runtime

Documentation

Index

• func NewFramework(r Registry, opts ...Option) (framework.Framework, error)
• type Option
• type PluginFactory
• type Registry
  • func (r Registry) FactoryNames() []string
  • func (r Registry) Filter(names []string) 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(r Registry, opts ...Option) (framework.Framework, error)

NewFramework creates a scheduling framework by registry.

Types

type Option

type Option func(*frameworkOptions)

Option for the frameworkImpl.

type PluginFactory

type PluginFactory = func() (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) FactoryNames

func (r Registry) FactoryNames() []string

FactoryNames returns all known plugin names

func (Registry) Filter

func (r Registry) Filter(names []string) Registry

Filter out the disabled plugin

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

Register adds a new plugin to the registry. If a plugin with the same name exists, it returns an 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.