plugin

Documentation

Index

• Variables
• type AppPlugin
  • func New(app *process.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 appproto.NodeClient) *Client
  • func (c *Client) Start() (int, error)
  • func (c *Client) Stop() error
• type Server
  • func NewServer(app *process.App) *Server
  • func (ns *Server) Start(_ context.Context, req *appproto.StartRequest) (*appproto.StartResponse, error)
  • func (ns *Server) Stop(_ context.Context, req *appproto.StopRequest) (*appproto.StopResponse, error)

Variables

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

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

PluginMap is the map of plugins we can dispense.

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 *process.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 appproto.NodeClient) *Client

NewServer returns a vm instance connected to a remote vm instance

func (*Client) Start

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

Blocks until the node is done shutting down. Returns the node's exit code.

func (*Client) Stop

func (c *Client) Stop() error

Blocks until the node is done shutting down.

type Server

type Server struct {
	appproto.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 *process.App) *Server

func (*Server) Start

func (ns *Server) Start(_ context.Context, req *appproto.StartRequest) (*appproto.StartResponse, error)

Blocks until the node returns

func (*Server) Stop

func (ns *Server) Stop(_ context.Context, req *appproto.StopRequest) (*appproto.StopResponse, error)

Blocks until the node is done shutting down