plugins

Documentation

Index

• type Jar
• type JobRunner
• type Plugin
• type PluginFactory

Types

type Jar

type Jar map[string]Plugin

Jar is a collection of plugins

type JobRunner

type JobRunner interface {
	// PluginByName returns plugin constructor
	PluginByName(pluginName string) (p PluginFactory, err error)

	// RunJob starts job in separate goroutine.
	//
	// Use ctx.Error channel to track job result and ctx.Cancel() to cancel it.
	RunJob(j manifest.Job, ctx *job.RunContext)
}

JobRunner runs jobs

type Plugin

type Plugin interface {
	// Call calls a plugin
	Call(*job.RunContext, JobRunner) error

	// Cancel stops plugin execution
	Cancel(*job.RunContext) error
}

Plugin represents Gilbert's plugin

type PluginFactory

type PluginFactory func(*scope.Scope, manifest.RawParams, logging.Logger) (Plugin, error)

PluginFactory is plugin constructor