plugin

Documentation

Index

• Constants
• Variables
• func Exec(path string, args []string, forwardIO bool) (app.App, *plugin.Client, error)
• func New(app app.App) plugin.Plugin
• type Client
  • func NewClient(node pluginpb.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) (*pluginpb.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",
	}

	// PluginMap is the map of plugins we can dispense.
	PluginMap = map[string]plugin.Plugin{
		Name: &appPlugin{},
	}
)

Functions

func Exec

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

func New

func New(app app.App) plugin.Plugin

New will be called by the server side of the plugin to pass into the server side PluginMap for dispatching.

Types

type Client

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

func NewClient

func NewClient(node pluginpb.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 {
	pluginpb.UnsafeNodeServer
	// 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) (*pluginpb.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)