plugins

package

v0.2.0 Latest Latest Go to latest Published: Feb 28, 2023 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/willabides/gotmpl

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func InitPlugins(ctx context.Context, commands, grpcAddresses []string, ...) (template.FuncMap, error)
func NewGrpcServer(p Plugin) pluginv1.PluginServiceServer
type InitPluginsOptions
type Plugin
type PluginServer
- func (p *PluginServer) GRPCClient(_ context.Context, _ *hcplugin.GRPCBroker, c *grpc.ClientConn) (any, error)
- func (p *PluginServer) GRPCServer(_ *hcplugin.GRPCBroker, s *grpc.Server) error

Constants ¶

This section is empty.

Variables ¶

View Source

var PluginHandshake = hcplugin.HandshakeConfig{
	ProtocolVersion:  1,
	MagicCookieKey:   "GOTMPL_PLUGIN",
	MagicCookieValue: "GOTMPL_PLUGIN",
}

PluginHandshake is the handshake config for plugins.

Functions ¶

func InitPlugins ¶

func InitPlugins(ctx context.Context, commands, grpcAddresses []string, options *InitPluginsOptions) (template.FuncMap, error)

InitPlugins initializes both command and grpc plugins and returns a single template.FuncMap that contains functions from all plugins with grpc plugins taking precedence over command plugins with the same name. When multiple plugins have the same name within the same type, the last one will be used. Command plugins will be killed when ctx is canceled.

func NewGrpcServer ¶

func NewGrpcServer(p Plugin) pluginv1.PluginServiceServer

Types ¶

type InitPluginsOptions ¶

type InitPluginsOptions struct {
	// ExecTimeout is the timeout calling ExecuteFunction on a plugin. Defaults to no timeout.
	ExecTimeout time.Duration
	// FunctionsTimeout is the timeout calling ListFunctions on a plugin. Defaults to no timeout.
	FunctionsTimeout time.Duration
}

type Plugin ¶

type Plugin interface {
	ListFunctions(ctx context.Context) ([]string, error)
	ExecuteFunction(ctx context.Context, name string, args []any) (any, error)
}

Plugin is the interface that plugins must implement.

type PluginServer ¶

type PluginServer struct {
	hcplugin.Plugin
	GotmplPlugin Plugin
}

func (*PluginServer) GRPCClient ¶

func (p *PluginServer) GRPCClient(_ context.Context, _ *hcplugin.GRPCBroker, c *grpc.ClientConn) (any, error)

func (*PluginServer) GRPCServer ¶

func (p *PluginServer) GRPCServer(_ *hcplugin.GRPCBroker, s *grpc.Server) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL