plugin

Documentation

Index

• type IPlugin
• type IPluginRegistry
• type Identifier
• type Plugin
  • func (p *Plugin) Dispense() (pluginV1.GatewayDPluginServiceClient, *gerr.GatewayDError)
  • func (p *Plugin) Start() (net.Addr, error)
  • func (p *Plugin) Stop()
• type PluginRegistry
  • func NewRegistry(hooksConfig *hook.Config) *PluginRegistry
  • func (reg *PluginRegistry) Add(plugin *Plugin) bool
  • func (reg *PluginRegistry) Exists(name, version, remoteURL string) bool
  • func (reg *PluginRegistry) Get(id Identifier) *Plugin
  • func (reg *PluginRegistry) List() []Identifier
  • func (reg *PluginRegistry) LoadPlugins(plugins []config.Plugin)
  • func (reg *PluginRegistry) RegisterHooks(id Identifier)
  • func (reg *PluginRegistry) Remove(id Identifier)
  • func (reg *PluginRegistry) Shutdown()

Types

type IPlugin

type IPlugin interface {
	Start() (net.Addr, error)
	Stop()
	Dispense() (pluginV1.GatewayDPluginServiceClient, *gerr.GatewayDError)
}

type IPluginRegistry

type IPluginRegistry interface {
	Add(plugin *Plugin) bool
	Get(id Identifier) *Plugin
	List() []Identifier
	Exists(name, version, remoteURL string) bool
	Remove(id Identifier)
	Shutdown()
	LoadPlugins(plugins []config.Plugin)
	RegisterHooks(id Identifier)
}

type Identifier

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

type Plugin

type Plugin struct {
	goplugin.NetRPCUnsupportedPlugin
	pluginV1.GatewayDPluginServiceServer

	ID          Identifier
	Description string
	Authors     []string
	License     string
	ProjectURL  string
	LocalPath   string
	Args        []string
	Env         []string
	Enabled     bool
	// internal and external config options
	Config map[string]string
	// hooks it attaches to
	Hooks    []hook.Type
	Priority hook.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 (*Plugin) Dispense

func (p *Plugin) Dispense() (pluginV1.GatewayDPluginServiceClient, *gerr.GatewayDError)

Dispense returns the plugin client.

func (*Plugin) Start

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

Start starts the plugin.

func (*Plugin) Stop

func (p *Plugin) Stop()

Stop kills the plugin.

type PluginRegistry

type PluginRegistry struct {
	CompatPolicy config.CompatPolicy
	// contains filtered or unexported fields
}

func NewRegistry

func NewRegistry(hooksConfig *hook.Config) *PluginRegistry

NewRegistry creates a new plugin registry.

func (*PluginRegistry) Add

func (reg *PluginRegistry) Add(plugin *Plugin) bool

Add adds a plugin to the registry.

func (*PluginRegistry) Exists

func (reg *PluginRegistry) Exists(name, version, remoteURL string) bool

Exists checks if a plugin exists in the registry.

func (*PluginRegistry) Get

func (reg *PluginRegistry) Get(id Identifier) *Plugin

Get returns a plugin from the registry.

func (*PluginRegistry) List

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

List returns a list of all plugins in the registry.

func (*PluginRegistry) LoadPlugins

func (reg *PluginRegistry) LoadPlugins(plugins []config.Plugin)

LoadPlugins loads plugins from the config file.

func (*PluginRegistry) RegisterHooks

func (reg *PluginRegistry) RegisterHooks(id Identifier)

RegisterHooks registers the hooks for the given plugin.

func (*PluginRegistry) Remove

func (reg *PluginRegistry) Remove(id Identifier)

Remove removes a plugin from the registry.

func (*PluginRegistry) Shutdown

func (reg *PluginRegistry) Shutdown()

Shutdown shuts down all plugins in the registry.