plugin

package

v1.7.2 Latest Latest Go to latest Published: Jul 4, 2023 License: BSD-3-Clause 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

View Source

const (
	Name = "nodeProcess"
)

View Source

var Handshake = plugin.HandshakeConfig{
	ProtocolVersion:  2,
	MagicCookieKey:   "NODE_PROCESS_PLUGIN",
	MagicCookieValue: "dynamic",
}

View Source

var PluginMap = map[string]plugin.Plugin{
	Name: &AppPlugin{},
}

PluginMap is the map of plugins we can dispense.

func Exec(path string, args []string, forwardIO bool) (app.App, *plugin.Client, error)

type AppPlugin struct {
	plugin.NetRPCUnsupportedPlugin
	// contains filtered or unexported fields
}

AppPlugin is can be served/consumed with the hashicorp plugin library. Plugin implements plugin.GRPCPlugin

func New(app app.App) *AppPlugin

func (p *AppPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)

GRPCClient returns a new GRPC client

func (p *AppPlugin) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error

GRPCServer registers a new GRPC server.

type Client struct {
	// contains filtered or unexported fields
}

func NewClient(node pluginproto.NodeClient) *Client

NewServer returns an app instance connected to a remote app instance

func (c *Client) ExitCode() (int, error)

func (c *Client) Start() error

func (c *Client) Stop() error

type Server struct {
	pluginproto.UnimplementedNodeServer
	// contains filtered or unexported fields
}

Server wraps a node so it can be served with the hashicorp plugin harness

func NewServer(app app.App) *Server

func (s *Server) ExitCode(context.Context, *emptypb.Empty) (*pluginproto.ExitCodeResponse, error)

func (s *Server) Start(context.Context, *emptypb.Empty) (*emptypb.Empty, error)

func (s *Server) Stop(context.Context, *emptypb.Empty) (*emptypb.Empty, error)

Path	Synopsis
pluginproto