plugin

Documentation

Overview

Package plugin contains general interfaces and types relevant to plugins. It also provides the methods for registering plugins.

Index

• type Mock
  • func (m *Mock) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag) (res contracts.PluginResult)
• type PluginRegistry
  • func RegisteredWorkerPlugins(context context.T) PluginRegistry
• type T

Types

type Mock

type Mock struct {
	mock.Mock
}

Mock stands for a mocked plugin.

func (*Mock) Execute

func (m *Mock) Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag) (res contracts.PluginResult)

Execute mocks a plugin execution.

type PluginRegistry

type PluginRegistry map[string]T

PluginRegistry stores a set of plugins, indexed by ID.

func RegisteredWorkerPlugins

func RegisteredWorkerPlugins(context context.T) PluginRegistry

RegisteredWorkerPlugins returns all registered core plugins.

type T

type T interface {
	Execute(context context.T, config contracts.Configuration, cancelFlag task.CancelFlag) contracts.PluginResult
}

T is the interface type for plugins.