plugin

Documentation

Index

• Constants
• Variables
• func Exec(path string, args []string, forwardIO bool) (app.App, *plugin.Client, error)
• type AppPlugin
  • func New(app app.App) *AppPlugin
  • func (p *AppPlugin) GRPCClient(_ context.Context, _ *plugin.GRPCBroker, c *grpc.ClientConn) (interface{}, error)
  • func (p *AppPlugin) GRPCServer(_ *plugin.GRPCBroker, s *grpc.Server) error
• type Client
  • func NewClient(node pluginproto.NodeClient) *Client
  • func (c *Client) ExitCode() (int, error)
  • func (c *Client) Start() error
  • func (c *Client) Stop() error
• type Server
  • 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)

Constants

const (
	Name = "nodeProcess"
)

Variables

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

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

PluginMap is the map of plugins we can dispense.

Functions

func Exec

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

Types

type AppPlugin

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

func New(app app.App) *AppPlugin

func (*AppPlugin) GRPCClient

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

GRPCClient returns a new GRPC client

func (*AppPlugin) GRPCServer

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

GRPCServer registers a new GRPC server.

type Client

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

func NewClient

func NewClient(node pluginproto.NodeClient) *Client

NewServer returns an app instance connected to a remote app instance

func (*Client) ExitCode

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

func (*Client) Start

func (c *Client) Start() error

func (*Client) Stop

func (c *Client) Stop() error

type Server

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

func NewServer(app app.App) *Server

func (*Server) ExitCode

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

func (*Server) Start

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

func (*Server) Stop

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