local

Documentation

Index

• func Execute(plugins func() discovery.Plugins, pluginManager *manager.Manager, ...) error
• type Options
• type StartPlugin
  • func FromAddressable(addr core.Addressable) StartPlugin
  • func Plugins(gid group.ID, gspec group_types.Spec) ([]StartPlugin, error)
  • func (arg StartPlugin) Parse() (execName string, kind string, name plugin.Name, err error)

Functions

func Execute

func Execute(plugins func() discovery.Plugins,
	pluginManager *manager.Manager,
	starts func() ([]StartPlugin, error),
	do scope.Work, options Options) error

Execute runs a unit of work with the specified list of plugins running.

Types

type Options

type Options struct {
	// StartWait is how long to wait to make sure all plugins are up
	StartWait types.Duration
	// StopWait is how long to wait to make sure all plugins are shut down
	StopWait types.Duration
}

Options are tuning parameters for executing a task in context of a set of plugins that are started as required.

type StartPlugin

type StartPlugin string

StartPlugin is a specification of what plugin to run and what socket name to use, etc. The format is kind[:{plugin_name}][={os|inproc}]

func FromAddressable

func FromAddressable(addr core.Addressable) StartPlugin

FromAddressable returns a StartPlugin encoded string

func Plugins

func Plugins(gid group.ID, gspec group_types.Spec) ([]StartPlugin, error)

Plugins returns a list of startPlugin directives from the input. This will recurse into any composable plugins.

func (StartPlugin) Parse

func (arg StartPlugin) Parse() (execName string, kind string, name plugin.Name, err error)

Parse parses the specification into parts that the manager can use to launch plugins